@wix/auto_sdk_events_wix-events-v-2 1.0.32 → 1.0.34
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/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-DqdnERTE.d.mts} +841 -495
- package/build/{internal/cjs/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-DqdnERTE.d.ts} +841 -495
- package/build/index.d.mts +220 -0
- package/build/index.d.ts +220 -0
- package/build/index.js +2657 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +2551 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/events-v3-event-wix-events-v-2.types.d.ts → internal/events-v3-event-wix-events-v-2.universal-DqdnERTE.d.mts} +841 -495
- package/build/internal/{es/src/events-v3-event-wix-events-v-2.types.d.ts → events-v3-event-wix-events-v-2.universal-DqdnERTE.d.ts} +841 -495
- package/build/internal/index.d.mts +220 -0
- package/build/internal/index.d.ts +220 -0
- package/build/internal/index.js +2657 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +2551 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +2848 -0
- package/build/internal/meta.d.ts +2848 -0
- package/build/internal/meta.js +1213 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1175 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +2848 -0
- package/build/meta.d.ts +2848 -0
- package/build/meta.js +1213 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1175 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.js +0 -134
- package/build/cjs/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js +0 -1031
- package/build/cjs/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.js +0 -256
- package/build/cjs/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js +0 -455
- package/build/cjs/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js +0 -676
- package/build/cjs/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5403
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1513
- package/build/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/es/src/events-v3-event-wix-events-v-2.context.js +0 -68
- package/build/es/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/es/src/events-v3-event-wix-events-v-2.http.js +0 -1016
- package/build/es/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/es/src/events-v3-event-wix-events-v-2.meta.js +0 -218
- package/build/es/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/es/src/events-v3-event-wix-events-v-2.public.js +0 -377
- package/build/es/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.types.js +0 -672
- package/build/es/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/es/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5403
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1474
- package/build/es/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.js +0 -134
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js +0 -1031
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.js +0 -256
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js +0 -455
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js +0 -676
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5403
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js +0 -1513
- package/build/internal/cjs/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.d.ts +0 -68
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.js +0 -68
- package/build/internal/es/src/events-v3-event-wix-events-v-2.context.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.d.ts +0 -87
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js +0 -1016
- package/build/internal/es/src/events-v3-event-wix-events-v-2.http.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.d.ts +0 -38
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.js +0 -218
- package/build/internal/es/src/events-v3-event-wix-events-v-2.meta.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.d.ts +0 -165
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js +0 -377
- package/build/internal/es/src/events-v3-event-wix-events-v-2.public.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js +0 -672
- package/build/internal/es/src/events-v3-event-wix-events-v-2.types.js.map +0 -1
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.d.ts +0 -5403
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js +0 -1474
- package/build/internal/es/src/events-v3-event-wix-events-v-2.universal.js.map +0 -1
package/build/meta.d.ts
ADDED
|
@@ -0,0 +1,2848 @@
|
|
|
1
|
+
import { cZ as CreateEventRequest$1, c_ as CreateEventResponse$1, c$ as CloneEventRequest$1, b as CloneEventResponse$1, d2 as UpdateEventRequest$1, d3 as UpdateEventResponse$1, d4 as PublishDraftEventRequest$1, c as PublishDraftEventResponse$1, d5 as CancelEventRequest$1, e as CancelEventResponse$1, d6 as BulkCancelEventsByFilterRequest$1, db as BulkCancelEventsByFilterResponse$1, dc as DeleteEventRequest$1, D as DeleteEventResponse$1, dd as BulkDeleteEventsByFilterRequest$1, de as BulkDeleteEventsByFilterResponse$1, df as QueryEventsRequest$1, dg as QueryEventsResponse$1, dt as CountEventsByStatusRequest$1, h as CountEventsByStatusResponse$1, dA as GetEventRequest$1, dB as GetEventResponse$1, dC as GetEventBySlugRequest$1, j as GetEventBySlugResponse$1 } from './events-v3-event-wix-events-v-2.universal-DqdnERTE.js';
|
|
2
|
+
|
|
3
|
+
interface V3Event {
|
|
4
|
+
/**
|
|
5
|
+
* Event ID.
|
|
6
|
+
* @format GUID
|
|
7
|
+
* @readonly
|
|
8
|
+
*/
|
|
9
|
+
id?: string;
|
|
10
|
+
/** Event location. */
|
|
11
|
+
location?: Location;
|
|
12
|
+
/** Event date and time settings. */
|
|
13
|
+
dateAndTimeSettings?: DateAndTimeSettings;
|
|
14
|
+
/**
|
|
15
|
+
* Event title.
|
|
16
|
+
* @minLength 1
|
|
17
|
+
* @maxLength 120
|
|
18
|
+
*/
|
|
19
|
+
title?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Short description that appears under the event title. <br>
|
|
22
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
23
|
+
* @maxLength 500
|
|
24
|
+
*/
|
|
25
|
+
shortDescription?: string | null;
|
|
26
|
+
/**
|
|
27
|
+
* Detailed description of an event.
|
|
28
|
+
*
|
|
29
|
+
* This field is deprecated.
|
|
30
|
+
* @maxLength 50000
|
|
31
|
+
* @deprecated Detailed description of an event.
|
|
32
|
+
*
|
|
33
|
+
* This field is deprecated.
|
|
34
|
+
* @replacedBy description
|
|
35
|
+
* @targetRemovalDate 2025-04-15
|
|
36
|
+
*/
|
|
37
|
+
detailedDescription?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* Main event image. <br>
|
|
40
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
41
|
+
*/
|
|
42
|
+
mainImage?: CommonImage;
|
|
43
|
+
/**
|
|
44
|
+
* Unique identifier of the event page. The naming is the same as the event title written in kebab case. For example, if your event title is "Leather Crafting 101", then the slug is "leather-crafting-101".
|
|
45
|
+
* @readonly
|
|
46
|
+
*/
|
|
47
|
+
slug?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Date and time when the event was created.
|
|
50
|
+
* @readonly
|
|
51
|
+
*/
|
|
52
|
+
createdDate?: Date | null;
|
|
53
|
+
/**
|
|
54
|
+
* Date and time when the event was updated.
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
updatedDate?: Date | null;
|
|
58
|
+
/**
|
|
59
|
+
* Event status.
|
|
60
|
+
* @readonly
|
|
61
|
+
*/
|
|
62
|
+
status?: StatusWithLiterals;
|
|
63
|
+
/**
|
|
64
|
+
* RSVP or ticketing registration details. <br>
|
|
65
|
+
* **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
|
|
66
|
+
*/
|
|
67
|
+
registration?: Registration;
|
|
68
|
+
/**
|
|
69
|
+
* URLs that allow you to add an event to the Google calendar, or to download an [ICS calendar](https://icscalendar.com/) file. <br>
|
|
70
|
+
* **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
|
|
71
|
+
* @readonly
|
|
72
|
+
*/
|
|
73
|
+
calendarUrls?: CalendarUrls;
|
|
74
|
+
/**
|
|
75
|
+
* Event page URL components. <br>
|
|
76
|
+
* **Note:** This field is returned only when the `URLS` fieldset is included in the request.
|
|
77
|
+
*/
|
|
78
|
+
eventPageUrl?: PageUrl;
|
|
79
|
+
/**
|
|
80
|
+
* Event registration form. <br>
|
|
81
|
+
* **Note:** This field is returned only when the `FORM` fieldset is included in the request.
|
|
82
|
+
*/
|
|
83
|
+
form?: Form;
|
|
84
|
+
/**
|
|
85
|
+
* Summary of RSVP or ticket sales. <br>
|
|
86
|
+
* **Note:** This field is returned only when the `DASHBOARD` fieldset is included in the request and you have the "WIX_EVENTS.READ_EVENT_DASHBOARD" permissions.
|
|
87
|
+
*/
|
|
88
|
+
summaries?: Summaries;
|
|
89
|
+
/**
|
|
90
|
+
* Instance ID of the site where the event is hosted.
|
|
91
|
+
* @readonly
|
|
92
|
+
*/
|
|
93
|
+
instanceId?: string;
|
|
94
|
+
/** Guest list configuration. */
|
|
95
|
+
guestListSettings?: GuestListSettings;
|
|
96
|
+
/**
|
|
97
|
+
* ID of the user who created the event.
|
|
98
|
+
* @readonly
|
|
99
|
+
* @format GUID
|
|
100
|
+
*/
|
|
101
|
+
userId?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Online conferencing details. <br>
|
|
104
|
+
* **Note:** This field is returned only when the `ONLINE_CONFERENCING_SESSION` fieldset is included in the request and you have the "WIX_EVENTS.READ_ONLINE_CONFERENCING" permissions.
|
|
105
|
+
*/
|
|
106
|
+
onlineConferencing?: OnlineConferencing;
|
|
107
|
+
/**
|
|
108
|
+
* SEO settings. <br>
|
|
109
|
+
* **Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request.
|
|
110
|
+
*/
|
|
111
|
+
seoSettings?: SeoSettings;
|
|
112
|
+
/**
|
|
113
|
+
* Assigned contacts label key.
|
|
114
|
+
* @readonly
|
|
115
|
+
*/
|
|
116
|
+
contactLabel?: string | null;
|
|
117
|
+
/**
|
|
118
|
+
* Event schedule details. <br>
|
|
119
|
+
* **Note:** This field is returned only when the `AGENDA` fieldset is included in the request.
|
|
120
|
+
*/
|
|
121
|
+
agendaSettings?: AgendaSettings;
|
|
122
|
+
/** Visual settings for event. */
|
|
123
|
+
eventDisplaySettings?: V3EventDisplaySettings;
|
|
124
|
+
/** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
|
|
125
|
+
description?: RichContent;
|
|
126
|
+
/**
|
|
127
|
+
* Event publish timestamp.
|
|
128
|
+
* @readonly
|
|
129
|
+
*/
|
|
130
|
+
publishedDate?: Date | null;
|
|
131
|
+
}
|
|
132
|
+
interface Location {
|
|
133
|
+
/**
|
|
134
|
+
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
135
|
+
* @maxLength 50
|
|
136
|
+
*/
|
|
137
|
+
name?: string | null;
|
|
138
|
+
/** Location type. */
|
|
139
|
+
type?: LocationTypeWithLiterals;
|
|
140
|
+
/** Exact location address. */
|
|
141
|
+
address?: CommonAddress;
|
|
142
|
+
/** Whether the event location is TBD. */
|
|
143
|
+
locationTbd?: boolean | null;
|
|
144
|
+
}
|
|
145
|
+
declare enum LocationType {
|
|
146
|
+
/** Unknown location type. */
|
|
147
|
+
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
148
|
+
/** Event is on-site at a specific physical location. */
|
|
149
|
+
VENUE = "VENUE",
|
|
150
|
+
/** Event is online, such as a virtual video conference. */
|
|
151
|
+
ONLINE = "ONLINE"
|
|
152
|
+
}
|
|
153
|
+
/** @enumType */
|
|
154
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
155
|
+
/** Physical address */
|
|
156
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
157
|
+
/** Street address. */
|
|
158
|
+
streetAddress?: CommonStreetAddress;
|
|
159
|
+
/**
|
|
160
|
+
* Primary address information (street and building number).
|
|
161
|
+
* @maxLength 250
|
|
162
|
+
*/
|
|
163
|
+
addressLine?: string | null;
|
|
164
|
+
/**
|
|
165
|
+
* 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
|
|
166
|
+
* @format COUNTRY
|
|
167
|
+
*/
|
|
168
|
+
country?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
|
|
171
|
+
* @maxLength 20
|
|
172
|
+
*/
|
|
173
|
+
subdivision?: string | null;
|
|
174
|
+
/**
|
|
175
|
+
* City name.
|
|
176
|
+
* @maxLength 100
|
|
177
|
+
*/
|
|
178
|
+
city?: string | null;
|
|
179
|
+
/**
|
|
180
|
+
* Zip or postal code.
|
|
181
|
+
* @maxLength 100
|
|
182
|
+
*/
|
|
183
|
+
postalCode?: string | null;
|
|
184
|
+
/**
|
|
185
|
+
* Secondary address information (suite or apartment number and room number).
|
|
186
|
+
* @maxLength 250
|
|
187
|
+
*/
|
|
188
|
+
addressLine2?: string | null;
|
|
189
|
+
}
|
|
190
|
+
/** @oneof */
|
|
191
|
+
interface CommonAddressStreetOneOf {
|
|
192
|
+
/** Street address. */
|
|
193
|
+
streetAddress?: CommonStreetAddress;
|
|
194
|
+
/**
|
|
195
|
+
* Primary address information (street and building number).
|
|
196
|
+
* @maxLength 250
|
|
197
|
+
*/
|
|
198
|
+
addressLine?: string | null;
|
|
199
|
+
}
|
|
200
|
+
interface CommonStreetAddress {
|
|
201
|
+
/**
|
|
202
|
+
* Street number.
|
|
203
|
+
* @maxLength 100
|
|
204
|
+
*/
|
|
205
|
+
number?: string;
|
|
206
|
+
/**
|
|
207
|
+
* Street name.
|
|
208
|
+
* @maxLength 250
|
|
209
|
+
*/
|
|
210
|
+
name?: string;
|
|
211
|
+
}
|
|
212
|
+
interface DateAndTimeSettings {
|
|
213
|
+
/** Whether the event date and time are TBD. */
|
|
214
|
+
dateAndTimeTbd?: boolean | null;
|
|
215
|
+
/**
|
|
216
|
+
* Message that is displayed when time and date is TBD.
|
|
217
|
+
*
|
|
218
|
+
* **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
|
|
219
|
+
* @maxLength 100
|
|
220
|
+
*/
|
|
221
|
+
dateAndTimeTbdMessage?: string | null;
|
|
222
|
+
/**
|
|
223
|
+
* Event start date.
|
|
224
|
+
*
|
|
225
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
226
|
+
*/
|
|
227
|
+
startDate?: Date | null;
|
|
228
|
+
/**
|
|
229
|
+
* Event end date.
|
|
230
|
+
*
|
|
231
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
232
|
+
*/
|
|
233
|
+
endDate?: Date | null;
|
|
234
|
+
/**
|
|
235
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
236
|
+
*
|
|
237
|
+
* **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
|
|
238
|
+
* @maxLength 100
|
|
239
|
+
*/
|
|
240
|
+
timeZoneId?: string | null;
|
|
241
|
+
/** Whether the end date is hidden in the formatted date and time. */
|
|
242
|
+
hideEndDate?: boolean | null;
|
|
243
|
+
/** Whether the time zone is displayed in the formatted schedule. */
|
|
244
|
+
showTimeZone?: boolean | null;
|
|
245
|
+
/**
|
|
246
|
+
* Repeating event status.
|
|
247
|
+
* @readonly
|
|
248
|
+
*/
|
|
249
|
+
recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
|
|
250
|
+
/** Event repetitions. */
|
|
251
|
+
recurringEvents?: Recurrences;
|
|
252
|
+
/** Formatted date and time settings. */
|
|
253
|
+
formatted?: Formatted;
|
|
254
|
+
}
|
|
255
|
+
declare enum RecurrenceStatusStatus {
|
|
256
|
+
/** Unknown recurrance status. */
|
|
257
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
258
|
+
/** Event happens only once and can last multiple days. */
|
|
259
|
+
ONE_TIME = "ONE_TIME",
|
|
260
|
+
/** A series of events that repeat. */
|
|
261
|
+
RECURRING = "RECURRING",
|
|
262
|
+
/** Next event in a schedule of recurring events. */
|
|
263
|
+
RECURRING_UPCOMING = "RECURRING_UPCOMING",
|
|
264
|
+
/** Latest event that ended in a schedule of recurring events. */
|
|
265
|
+
RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
|
|
266
|
+
/** Latest canceled event in a schedule of recurring events */
|
|
267
|
+
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
268
|
+
}
|
|
269
|
+
/** @enumType */
|
|
270
|
+
type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
271
|
+
interface Recurrences {
|
|
272
|
+
/**
|
|
273
|
+
* Individual event dates.
|
|
274
|
+
* @maxSize 1000
|
|
275
|
+
*/
|
|
276
|
+
individualEventDates?: Occurrence[];
|
|
277
|
+
/**
|
|
278
|
+
* Recurring event category ID.
|
|
279
|
+
* @readonly
|
|
280
|
+
* @maxLength 100
|
|
281
|
+
*/
|
|
282
|
+
categoryId?: string | null;
|
|
283
|
+
}
|
|
284
|
+
interface Occurrence {
|
|
285
|
+
/** Event start date. */
|
|
286
|
+
startDate?: Date | null;
|
|
287
|
+
/** Event end date. */
|
|
288
|
+
endDate?: Date | null;
|
|
289
|
+
/**
|
|
290
|
+
* Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
|
|
291
|
+
* @maxLength 100
|
|
292
|
+
*/
|
|
293
|
+
timeZoneId?: string | null;
|
|
294
|
+
/** Whether the time zone is displayed in a formatted schedule. */
|
|
295
|
+
showTimeZone?: boolean;
|
|
296
|
+
}
|
|
297
|
+
interface Formatted {
|
|
298
|
+
/**
|
|
299
|
+
* Formatted date and time representation. <br>
|
|
300
|
+
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
|
|
301
|
+
* Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
|
|
302
|
+
* @readonly
|
|
303
|
+
* @maxLength 500
|
|
304
|
+
*/
|
|
305
|
+
dateAndTime?: string | null;
|
|
306
|
+
/**
|
|
307
|
+
* Formatted start date of the event. Empty for TBD schedules.
|
|
308
|
+
* @readonly
|
|
309
|
+
* @maxLength 500
|
|
310
|
+
*/
|
|
311
|
+
startDate?: string | null;
|
|
312
|
+
/**
|
|
313
|
+
* Formatted start time of the event. Empty for TBD schedules.
|
|
314
|
+
* @readonly
|
|
315
|
+
* @maxLength 500
|
|
316
|
+
*/
|
|
317
|
+
startTime?: string | null;
|
|
318
|
+
/**
|
|
319
|
+
* Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
|
|
320
|
+
* @readonly
|
|
321
|
+
* @maxLength 500
|
|
322
|
+
*/
|
|
323
|
+
endDate?: string | null;
|
|
324
|
+
/**
|
|
325
|
+
* Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
|
|
326
|
+
* @readonly
|
|
327
|
+
* @maxLength 500
|
|
328
|
+
*/
|
|
329
|
+
endTime?: string | null;
|
|
330
|
+
}
|
|
331
|
+
declare enum Status {
|
|
332
|
+
/** Unknown event status. */
|
|
333
|
+
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
334
|
+
/** Event is published and scheduled to start. */
|
|
335
|
+
UPCOMING = "UPCOMING",
|
|
336
|
+
/** Event has started. */
|
|
337
|
+
STARTED = "STARTED",
|
|
338
|
+
/** Event has ended. */
|
|
339
|
+
ENDED = "ENDED",
|
|
340
|
+
/** Event is canceled. */
|
|
341
|
+
CANCELED = "CANCELED",
|
|
342
|
+
/** Event is not public. */
|
|
343
|
+
DRAFT = "DRAFT"
|
|
344
|
+
}
|
|
345
|
+
/** @enumType */
|
|
346
|
+
type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
347
|
+
interface PageUrl {
|
|
348
|
+
/**
|
|
349
|
+
* The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
|
|
350
|
+
* @maxLength 500
|
|
351
|
+
*/
|
|
352
|
+
base?: string;
|
|
353
|
+
/**
|
|
354
|
+
* The path to the page. For example, `/product-page/a-product`.
|
|
355
|
+
* @maxLength 500
|
|
356
|
+
*/
|
|
357
|
+
path?: string;
|
|
358
|
+
}
|
|
359
|
+
interface Registration {
|
|
360
|
+
/**
|
|
361
|
+
* Current registration type.
|
|
362
|
+
* @readonly
|
|
363
|
+
*/
|
|
364
|
+
type?: RegistrationTypeTypeWithLiterals;
|
|
365
|
+
/**
|
|
366
|
+
* Registration status.
|
|
367
|
+
* @readonly
|
|
368
|
+
*/
|
|
369
|
+
status?: RegistrationStatusStatusWithLiterals;
|
|
370
|
+
/** RSVP registration details. */
|
|
371
|
+
rsvp?: RsvpRegistration;
|
|
372
|
+
/** Ticket registration details. */
|
|
373
|
+
tickets?: TicketsRegistration;
|
|
374
|
+
/** External registration details. */
|
|
375
|
+
external?: ExternalRegistration;
|
|
376
|
+
/** Types of guests allowed to register. */
|
|
377
|
+
allowedGuestTypes?: GuestTypeTypeWithLiterals;
|
|
378
|
+
/**
|
|
379
|
+
* Initial event type which is set when creating an event.
|
|
380
|
+
* @immutable
|
|
381
|
+
*/
|
|
382
|
+
initialType?: InitialRegistrationTypeTypeWithLiterals;
|
|
383
|
+
/** Whether the registration is paused. */
|
|
384
|
+
registrationPaused?: boolean;
|
|
385
|
+
/** Whether the registration is disabled. */
|
|
386
|
+
registrationDisabled?: boolean;
|
|
387
|
+
}
|
|
388
|
+
declare enum RegistrationTypeType {
|
|
389
|
+
/** Unknown registration type. */
|
|
390
|
+
UNKNOWN_REGISTRATION_TYPE = "UNKNOWN_REGISTRATION_TYPE",
|
|
391
|
+
/** Guests register by RSVPing to the event. */
|
|
392
|
+
RSVP = "RSVP",
|
|
393
|
+
/** Guests register by buying tickets. */
|
|
394
|
+
TICKETING = "TICKETING",
|
|
395
|
+
/** Guests register externally using some other site or platform. */
|
|
396
|
+
EXTERNAL = "EXTERNAL",
|
|
397
|
+
/** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
|
|
398
|
+
NONE = "NONE"
|
|
399
|
+
}
|
|
400
|
+
/** @enumType */
|
|
401
|
+
type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
|
|
402
|
+
declare enum RegistrationStatusStatus {
|
|
403
|
+
/** Registration status is not applicable */
|
|
404
|
+
UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
|
|
405
|
+
/** Registration is closed after tickets are sold out. */
|
|
406
|
+
CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
|
|
407
|
+
/** Registration is closed when the `registration.registrationDisabled` property is set to `true`. */
|
|
408
|
+
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
409
|
+
/** Guests can start RSVPing to the event. */
|
|
410
|
+
OPEN_RSVP = "OPEN_RSVP",
|
|
411
|
+
/** Guest list has reached the maximum, new guests are added to a waitlist. */
|
|
412
|
+
OPEN_RSVP_WAITLIST_ONLY = "OPEN_RSVP_WAITLIST_ONLY",
|
|
413
|
+
/** Guests can buy tickets to the event. */
|
|
414
|
+
OPEN_TICKETS = "OPEN_TICKETS",
|
|
415
|
+
/** Guests register on a different page or web address. */
|
|
416
|
+
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
417
|
+
/** Registration via RSVP is scheduled for the future. */
|
|
418
|
+
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
419
|
+
}
|
|
420
|
+
/** @enumType */
|
|
421
|
+
type RegistrationStatusStatusWithLiterals = RegistrationStatusStatus | 'UNKNOWN_REGISTRATION_STATUS' | 'CLOSED_AUTOMATICALLY' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST_ONLY' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
422
|
+
interface RsvpRegistration {
|
|
423
|
+
/** Available answers for registration to an event. */
|
|
424
|
+
responseType?: ResponseTypeWithLiterals;
|
|
425
|
+
/** How many guests can RSVP to an event. */
|
|
426
|
+
limit?: number | null;
|
|
427
|
+
/** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
|
|
428
|
+
waitlistEnabled?: boolean;
|
|
429
|
+
/** Registration start date. */
|
|
430
|
+
startDate?: Date | null;
|
|
431
|
+
/** Registration end date. */
|
|
432
|
+
endDate?: Date | null;
|
|
433
|
+
}
|
|
434
|
+
declare enum ResponseType {
|
|
435
|
+
/** Unknown response type. */
|
|
436
|
+
UNKNOWN_RESPONSE_TYPE = "UNKNOWN_RESPONSE_TYPE",
|
|
437
|
+
/** Only a **Yes** answer is available to select when RSVP'ing to an event. */
|
|
438
|
+
YES_ONLY = "YES_ONLY",
|
|
439
|
+
/** *Yes** and **No** answers are available to select when RSVP'ing to an event. */
|
|
440
|
+
YES_AND_NO = "YES_AND_NO"
|
|
441
|
+
}
|
|
442
|
+
/** @enumType */
|
|
443
|
+
type ResponseTypeWithLiterals = ResponseType | 'UNKNOWN_RESPONSE_TYPE' | 'YES_ONLY' | 'YES_AND_NO';
|
|
444
|
+
interface TicketsRegistration {
|
|
445
|
+
/** Whether the registration form must be filled out separately for each ticket. */
|
|
446
|
+
guestsAssignedSeparately?: boolean;
|
|
447
|
+
/**
|
|
448
|
+
* Ticket limit per order. <br>
|
|
449
|
+
* Default: 20 tickets.
|
|
450
|
+
* @max 50
|
|
451
|
+
*/
|
|
452
|
+
ticketLimitPerOrder?: number;
|
|
453
|
+
/** Ticket price currency. */
|
|
454
|
+
currency?: string | null;
|
|
455
|
+
/**
|
|
456
|
+
* Lowest ticket price.
|
|
457
|
+
* @readonly
|
|
458
|
+
*/
|
|
459
|
+
lowestPrice?: Money;
|
|
460
|
+
/**
|
|
461
|
+
* Highest ticket price.
|
|
462
|
+
* @readonly
|
|
463
|
+
*/
|
|
464
|
+
highestPrice?: Money;
|
|
465
|
+
/**
|
|
466
|
+
* Whether all tickets are sold for the event.
|
|
467
|
+
* @readonly
|
|
468
|
+
*/
|
|
469
|
+
soldOut?: boolean | null;
|
|
470
|
+
/** How tax is applied. */
|
|
471
|
+
taxSettings?: TaxSettings;
|
|
472
|
+
/**
|
|
473
|
+
* Reservation duration in minutes.
|
|
474
|
+
* @min 5
|
|
475
|
+
* @max 30
|
|
476
|
+
*/
|
|
477
|
+
reservationDurationInMinutes?: number | null;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* Money.
|
|
481
|
+
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
482
|
+
*/
|
|
483
|
+
interface Money {
|
|
484
|
+
/**
|
|
485
|
+
* Amount of money in decimal form. A period is used as a decimal separator (for example, `3.99`).
|
|
486
|
+
* @format DECIMAL_VALUE
|
|
487
|
+
*/
|
|
488
|
+
value?: string;
|
|
489
|
+
/**
|
|
490
|
+
* Currency code in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
491
|
+
* @format CURRENCY
|
|
492
|
+
*/
|
|
493
|
+
currency?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Amount of money in decimal form. A period or comma are used as a decimal separator (for example, `1 000,30`).
|
|
496
|
+
* @readonly
|
|
497
|
+
*/
|
|
498
|
+
formattedValue?: string | null;
|
|
499
|
+
}
|
|
500
|
+
interface TaxSettings {
|
|
501
|
+
/** Tax application settings. */
|
|
502
|
+
type?: TaxTypeWithLiterals;
|
|
503
|
+
/**
|
|
504
|
+
* Tax name.
|
|
505
|
+
* @minLength 1
|
|
506
|
+
* @maxLength 10
|
|
507
|
+
*/
|
|
508
|
+
name?: string | null;
|
|
509
|
+
/**
|
|
510
|
+
* Tax rate (for example,`21.55`).
|
|
511
|
+
* @decimalValue options { gte:0.001, lte:100, maxScale:3 }
|
|
512
|
+
*/
|
|
513
|
+
rate?: string | null;
|
|
514
|
+
/** Apply tax to donations. */
|
|
515
|
+
appliedToDonations?: boolean | null;
|
|
516
|
+
}
|
|
517
|
+
/** Tax application settings. */
|
|
518
|
+
declare enum TaxType {
|
|
519
|
+
/** Unknown tax type. */
|
|
520
|
+
UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
|
|
521
|
+
/** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
|
|
522
|
+
INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
|
|
523
|
+
/** Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket ticket service fee of $0.25 and pays $10.25 in total. */
|
|
524
|
+
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
525
|
+
}
|
|
526
|
+
/** @enumType */
|
|
527
|
+
type TaxTypeWithLiterals = TaxType | 'UNKNOWN_TAX_TYPE' | 'INCLUDED_IN_PRICE' | 'ADDED_AT_CHECKOUT';
|
|
528
|
+
interface ExternalRegistration {
|
|
529
|
+
/**
|
|
530
|
+
* External event registration URL.
|
|
531
|
+
* @format WEB_URL
|
|
532
|
+
*/
|
|
533
|
+
url?: string | null;
|
|
534
|
+
}
|
|
535
|
+
declare enum GuestTypeType {
|
|
536
|
+
/** Unknown guest type. */
|
|
537
|
+
UNKNOWN_GUEST_TYPE = "UNKNOWN_GUEST_TYPE",
|
|
538
|
+
/** All site visitors can RSVP to the event. */
|
|
539
|
+
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER",
|
|
540
|
+
/** Only people who have signed up as members of your site are able to RSVP to the event. */
|
|
541
|
+
MEMBER = "MEMBER"
|
|
542
|
+
}
|
|
543
|
+
/** @enumType */
|
|
544
|
+
type GuestTypeTypeWithLiterals = GuestTypeType | 'UNKNOWN_GUEST_TYPE' | 'VISITOR_OR_MEMBER' | 'MEMBER';
|
|
545
|
+
declare enum InitialRegistrationTypeType {
|
|
546
|
+
/** Unknown initial registration type. */
|
|
547
|
+
UNKNOWN_INITIAL_REGISTRATION_TYPE = "UNKNOWN_INITIAL_REGISTRATION_TYPE",
|
|
548
|
+
/** Guests register by RSVPing to the event. */
|
|
549
|
+
RSVP = "RSVP",
|
|
550
|
+
/** Guests register by buying tickets. This property value never changes. */
|
|
551
|
+
TICKETING = "TICKETING"
|
|
552
|
+
}
|
|
553
|
+
/** @enumType */
|
|
554
|
+
type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
|
|
555
|
+
interface CommonImage {
|
|
556
|
+
/**
|
|
557
|
+
* WixMedia image ID.
|
|
558
|
+
* @minLength 1
|
|
559
|
+
* @maxLength 200
|
|
560
|
+
*/
|
|
561
|
+
id?: string;
|
|
562
|
+
/** Image URL. */
|
|
563
|
+
url?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Original image height.
|
|
566
|
+
*
|
|
567
|
+
* **Note:** You have to define height for the image to appear.
|
|
568
|
+
*/
|
|
569
|
+
height?: number;
|
|
570
|
+
/**
|
|
571
|
+
* Original image width.
|
|
572
|
+
*
|
|
573
|
+
* **Note:** You have to define width for the image to appear.
|
|
574
|
+
*/
|
|
575
|
+
width?: number;
|
|
576
|
+
/** Image alt text. */
|
|
577
|
+
altText?: string | null;
|
|
578
|
+
}
|
|
579
|
+
interface CalendarUrls {
|
|
580
|
+
/**
|
|
581
|
+
* "Add to Google calendar" URL.
|
|
582
|
+
* @readonly
|
|
583
|
+
*/
|
|
584
|
+
google?: string;
|
|
585
|
+
/**
|
|
586
|
+
* "Download ICS calendar file" URL.
|
|
587
|
+
* @readonly
|
|
588
|
+
*/
|
|
589
|
+
ics?: string;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* The form defines which elements are displayed to a site visitor during the registration process (RSVP or checkout).
|
|
593
|
+
* It also contains customizable messages and labels.
|
|
594
|
+
*
|
|
595
|
+
*
|
|
596
|
+
* A form is an ordered list of controls (blocks), which accept guest information into a field input.
|
|
597
|
+
*
|
|
598
|
+
* Each control contains one or more nested inputs. For example, `Name` control has two inputs:
|
|
599
|
+
* - First Name
|
|
600
|
+
* - Last Name
|
|
601
|
+
*
|
|
602
|
+
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
603
|
+
*/
|
|
604
|
+
interface Form {
|
|
605
|
+
/** Nested fields as an ordered list. */
|
|
606
|
+
controls?: InputControl[];
|
|
607
|
+
/**
|
|
608
|
+
* Set of defined form messages displayed in the UI before, during, and after a registration flow.
|
|
609
|
+
* Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
610
|
+
*/
|
|
611
|
+
messages?: FormMessages;
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* A block of nested fields.
|
|
615
|
+
* Used to aggregate similar inputs like First Name and Last Name.
|
|
616
|
+
*/
|
|
617
|
+
interface InputControl {
|
|
618
|
+
/** Field control type. */
|
|
619
|
+
type?: InputControlTypeWithLiterals;
|
|
620
|
+
/** Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. */
|
|
621
|
+
system?: boolean;
|
|
622
|
+
/**
|
|
623
|
+
* Deprecated: Use `id` or `_id`.
|
|
624
|
+
* @deprecated
|
|
625
|
+
*/
|
|
626
|
+
name?: string;
|
|
627
|
+
/** Child inputs. */
|
|
628
|
+
inputs?: Input[];
|
|
629
|
+
/**
|
|
630
|
+
* *Deprecated:** Use `controls.inputs.label`.
|
|
631
|
+
* @deprecated
|
|
632
|
+
*/
|
|
633
|
+
label?: string;
|
|
634
|
+
/** Field controls are sorted by this value in ascending order. */
|
|
635
|
+
orderIndex?: number;
|
|
636
|
+
/** Unique control ID. */
|
|
637
|
+
id?: string;
|
|
638
|
+
/**
|
|
639
|
+
* Whether the input control is deleted.
|
|
640
|
+
* @readonly
|
|
641
|
+
*/
|
|
642
|
+
deleted?: boolean | null;
|
|
643
|
+
}
|
|
644
|
+
declare enum InputControlType {
|
|
645
|
+
/** Single text value field. */
|
|
646
|
+
INPUT = "INPUT",
|
|
647
|
+
/** Single text value field with multiple lines. */
|
|
648
|
+
TEXTAREA = "TEXTAREA",
|
|
649
|
+
/** Single-choice field with predefined values. */
|
|
650
|
+
DROPDOWN = "DROPDOWN",
|
|
651
|
+
/** Single-choice field with predefined values. */
|
|
652
|
+
RADIO = "RADIO",
|
|
653
|
+
/** Multiple-choice field with predefined values. */
|
|
654
|
+
CHECKBOX = "CHECKBOX",
|
|
655
|
+
/** Fields for entering first and last names. */
|
|
656
|
+
NAME = "NAME",
|
|
657
|
+
/** Fields for additional guests and their respective names. */
|
|
658
|
+
GUEST_CONTROL = "GUEST_CONTROL",
|
|
659
|
+
/** Single-line address field. */
|
|
660
|
+
ADDRESS_SHORT = "ADDRESS_SHORT",
|
|
661
|
+
/** Full address field with multiple lines. */
|
|
662
|
+
ADDRESS_FULL = "ADDRESS_FULL",
|
|
663
|
+
/** Fields for entering year, month, and day. */
|
|
664
|
+
DATE = "DATE"
|
|
665
|
+
}
|
|
666
|
+
/** @enumType */
|
|
667
|
+
type InputControlTypeWithLiterals = InputControlType | 'INPUT' | 'TEXTAREA' | 'DROPDOWN' | 'RADIO' | 'CHECKBOX' | 'NAME' | 'GUEST_CONTROL' | 'ADDRESS_SHORT' | 'ADDRESS_FULL' | 'DATE';
|
|
668
|
+
/** Child inputs. */
|
|
669
|
+
interface Input {
|
|
670
|
+
/** Field name. */
|
|
671
|
+
name?: string;
|
|
672
|
+
/**
|
|
673
|
+
* *Deprecated:** Use `controls.inputs.type.TEXT_ARRAY`.
|
|
674
|
+
* @deprecated
|
|
675
|
+
*/
|
|
676
|
+
array?: boolean;
|
|
677
|
+
/** Main field label. */
|
|
678
|
+
label?: string;
|
|
679
|
+
/** Additional labels for multi-valued fields such as address. */
|
|
680
|
+
additionalLabels?: Record<string, string>;
|
|
681
|
+
/** Predefined choice options for fields, such as dropdown. */
|
|
682
|
+
options?: string[];
|
|
683
|
+
/** Whether field is mandatory. */
|
|
684
|
+
mandatory?: boolean;
|
|
685
|
+
/** Maximum number of accepted characters (relevant for text fields). */
|
|
686
|
+
maxLength?: number;
|
|
687
|
+
/**
|
|
688
|
+
* Type which determines field format.
|
|
689
|
+
* Used to validate submitted response.
|
|
690
|
+
*/
|
|
691
|
+
type?: ValueTypeWithLiterals;
|
|
692
|
+
/**
|
|
693
|
+
* The maximum number of accepted values for array input.
|
|
694
|
+
*
|
|
695
|
+
* **Note:** Only applicable for `TEXT_ARRAY` input fields.
|
|
696
|
+
*/
|
|
697
|
+
maxSize?: number | null;
|
|
698
|
+
/**
|
|
699
|
+
* Default option initially selected when an input has multiple choices.
|
|
700
|
+
*
|
|
701
|
+
* Defaults to first (0th) option, if not configured.
|
|
702
|
+
* Currently only applicable for `type.dropdown`.
|
|
703
|
+
*/
|
|
704
|
+
defaultOptionSelection?: OptionSelection;
|
|
705
|
+
/**
|
|
706
|
+
* Additional labels for multi-valued fields, such as address.
|
|
707
|
+
* @readonly
|
|
708
|
+
*/
|
|
709
|
+
labels?: Label[];
|
|
710
|
+
}
|
|
711
|
+
declare enum ValueType {
|
|
712
|
+
TEXT = "TEXT",
|
|
713
|
+
NUMBER = "NUMBER",
|
|
714
|
+
TEXT_ARRAY = "TEXT_ARRAY",
|
|
715
|
+
DATE_TIME = "DATE_TIME",
|
|
716
|
+
ADDRESS = "ADDRESS"
|
|
717
|
+
}
|
|
718
|
+
/** @enumType */
|
|
719
|
+
type ValueTypeWithLiterals = ValueType | 'TEXT' | 'NUMBER' | 'TEXT_ARRAY' | 'DATE_TIME' | 'ADDRESS';
|
|
720
|
+
/**
|
|
721
|
+
* Describes initially selected option when an input has multiple choices.
|
|
722
|
+
* Defaults to first (0th) option if not configured.
|
|
723
|
+
*/
|
|
724
|
+
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
725
|
+
/**
|
|
726
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
727
|
+
* @max 199
|
|
728
|
+
*/
|
|
729
|
+
optionIndex?: number;
|
|
730
|
+
/**
|
|
731
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
732
|
+
* Considered an empty choice.
|
|
733
|
+
* @maxLength 200
|
|
734
|
+
*/
|
|
735
|
+
placeholderText?: string;
|
|
736
|
+
}
|
|
737
|
+
/** @oneof */
|
|
738
|
+
interface OptionSelectionSelectedOptionOneOf {
|
|
739
|
+
/**
|
|
740
|
+
* 0-based index from predefined `controls.inputs.options` which is initial selection.
|
|
741
|
+
* @max 199
|
|
742
|
+
*/
|
|
743
|
+
optionIndex?: number;
|
|
744
|
+
/**
|
|
745
|
+
* Placeholder hint describing expected choices, such as "Please select".
|
|
746
|
+
* Considered an empty choice.
|
|
747
|
+
* @maxLength 200
|
|
748
|
+
*/
|
|
749
|
+
placeholderText?: string;
|
|
750
|
+
}
|
|
751
|
+
interface Label {
|
|
752
|
+
/** Field name. */
|
|
753
|
+
name?: string;
|
|
754
|
+
/** Field label. */
|
|
755
|
+
label?: string;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Defines form messages shown in UI before, during, and after registration flow.
|
|
759
|
+
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
760
|
+
*/
|
|
761
|
+
interface FormMessages {
|
|
762
|
+
/** RSVP form ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/rsvp-v2/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction)) messages. */
|
|
763
|
+
rsvp?: RsvpFormMessages;
|
|
764
|
+
/** Checkout form messages. */
|
|
765
|
+
checkout?: CheckoutFormMessages;
|
|
766
|
+
/** Messages shown when event registration is closed. */
|
|
767
|
+
registrationClosed?: RegistrationClosedMessages;
|
|
768
|
+
/** Messages shown when event tickets are unavailable. */
|
|
769
|
+
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
770
|
+
}
|
|
771
|
+
interface RsvpFormMessages {
|
|
772
|
+
/** Label text indicating RSVP's `status` is `"YES"`. */
|
|
773
|
+
rsvpYesOption?: string;
|
|
774
|
+
/** Label text indicating RSVP's `status` is `"NO"`. */
|
|
775
|
+
rsvpNoOption?: string;
|
|
776
|
+
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
777
|
+
positiveMessages?: Positive;
|
|
778
|
+
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
779
|
+
waitlistMessages?: Positive;
|
|
780
|
+
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
781
|
+
negativeMessages?: Negative;
|
|
782
|
+
/** "Submit form" call-to-action label text. */
|
|
783
|
+
submitActionLabel?: string;
|
|
784
|
+
}
|
|
785
|
+
/** Confirmation messages shown after registration. */
|
|
786
|
+
interface PositiveResponseConfirmation {
|
|
787
|
+
/** Confirmation message title. */
|
|
788
|
+
title?: string;
|
|
789
|
+
/** Confirmation message text. */
|
|
790
|
+
message?: string;
|
|
791
|
+
/** "Add to calendar" call-to-action label text. */
|
|
792
|
+
addToCalendarActionLabel?: string;
|
|
793
|
+
/** "Share event" call-to-action label text. */
|
|
794
|
+
shareActionLabel?: string;
|
|
795
|
+
}
|
|
796
|
+
/** Confirmation messages shown after registration. */
|
|
797
|
+
interface NegativeResponseConfirmation {
|
|
798
|
+
/** Confirmation message title. */
|
|
799
|
+
title?: string;
|
|
800
|
+
/** "Share event" call-to-action label text. */
|
|
801
|
+
shareActionLabel?: string;
|
|
802
|
+
}
|
|
803
|
+
/** Set of messages shown during registration when RSVP response is positive. */
|
|
804
|
+
interface Positive {
|
|
805
|
+
/** Main form title for positive response. */
|
|
806
|
+
title?: string;
|
|
807
|
+
/** Confirmation messages shown after registration. */
|
|
808
|
+
confirmation?: PositiveResponseConfirmation;
|
|
809
|
+
}
|
|
810
|
+
/** A set of messages shown during registration with negative response */
|
|
811
|
+
interface Negative {
|
|
812
|
+
/** Main form title for negative response. */
|
|
813
|
+
title?: string;
|
|
814
|
+
/** Confirmation messages shown after registration. */
|
|
815
|
+
confirmation?: NegativeResponseConfirmation;
|
|
816
|
+
}
|
|
817
|
+
interface CheckoutFormMessages {
|
|
818
|
+
/** Main form title for response. */
|
|
819
|
+
title?: string;
|
|
820
|
+
/** Submit form call-to-action label text. */
|
|
821
|
+
submitActionLabel?: string;
|
|
822
|
+
/** Confirmation messages shown after checkout. */
|
|
823
|
+
confirmation?: ResponseConfirmation;
|
|
824
|
+
}
|
|
825
|
+
/** Confirmation messages shown after checkout. */
|
|
826
|
+
interface ResponseConfirmation {
|
|
827
|
+
/** Confirmation message title. */
|
|
828
|
+
title?: string;
|
|
829
|
+
/** Confirmation message text. */
|
|
830
|
+
message?: string;
|
|
831
|
+
/** "Download tickets" call-to-action label text. */
|
|
832
|
+
downloadTicketsLabel?: string;
|
|
833
|
+
/** "Add to calendar" call-to-action label text. */
|
|
834
|
+
addToCalendarLabel?: string;
|
|
835
|
+
/** "Share event" call-to-action label text. */
|
|
836
|
+
shareEventLabel?: string;
|
|
837
|
+
}
|
|
838
|
+
interface RegistrationClosedMessages {
|
|
839
|
+
/** Message shown when event registration is closed. */
|
|
840
|
+
message?: string;
|
|
841
|
+
/** "Explore other events" call-to-action label text. */
|
|
842
|
+
exploreEventsActionLabel?: string;
|
|
843
|
+
}
|
|
844
|
+
interface TicketsUnavailableMessages {
|
|
845
|
+
/** Message shown when event tickets are unavailable. */
|
|
846
|
+
message?: string;
|
|
847
|
+
/** "Explore other events" call-to-action label text. */
|
|
848
|
+
exploreEventsActionLabel?: string;
|
|
849
|
+
}
|
|
850
|
+
interface Summaries {
|
|
851
|
+
/** RSVP summary of guests. */
|
|
852
|
+
rsvps?: Rsvps;
|
|
853
|
+
/** Summary of revenue and sold tickets. Archived orders are not included. */
|
|
854
|
+
tickets?: Tickets;
|
|
855
|
+
}
|
|
856
|
+
interface EventsMoney {
|
|
857
|
+
/**
|
|
858
|
+
* *Deprecated:** Use `value` instead.
|
|
859
|
+
* @format DECIMAL_VALUE
|
|
860
|
+
* @deprecated
|
|
861
|
+
*/
|
|
862
|
+
amount?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
865
|
+
* @format CURRENCY
|
|
866
|
+
*/
|
|
867
|
+
currency?: string;
|
|
868
|
+
/**
|
|
869
|
+
* Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative.
|
|
870
|
+
* @format DECIMAL_VALUE
|
|
871
|
+
*/
|
|
872
|
+
value?: string | null;
|
|
873
|
+
}
|
|
874
|
+
interface Rsvps {
|
|
875
|
+
/**
|
|
876
|
+
* Total number of RSVPs.
|
|
877
|
+
* @readonly
|
|
878
|
+
*/
|
|
879
|
+
totalCount?: number;
|
|
880
|
+
/**
|
|
881
|
+
* Number of RSVPs with status `YES`.
|
|
882
|
+
* @readonly
|
|
883
|
+
*/
|
|
884
|
+
yesCount?: number;
|
|
885
|
+
/**
|
|
886
|
+
* Number of RSVPs with status `NO`.
|
|
887
|
+
* @readonly
|
|
888
|
+
*/
|
|
889
|
+
noCount?: number;
|
|
890
|
+
/**
|
|
891
|
+
* Number of RSVPs in a waitlist.
|
|
892
|
+
* @readonly
|
|
893
|
+
*/
|
|
894
|
+
waitlistCount?: number;
|
|
895
|
+
}
|
|
896
|
+
interface Tickets {
|
|
897
|
+
/**
|
|
898
|
+
* Number of sold tickets.
|
|
899
|
+
* @readonly
|
|
900
|
+
*/
|
|
901
|
+
ticketsSold?: number;
|
|
902
|
+
/**
|
|
903
|
+
* Total revenue. Taxes and payment provider fees aren't deducted.
|
|
904
|
+
* @readonly
|
|
905
|
+
*/
|
|
906
|
+
revenue?: EventsMoney;
|
|
907
|
+
/**
|
|
908
|
+
* Whether the currency is locked and can’t be changed.
|
|
909
|
+
* @readonly
|
|
910
|
+
*/
|
|
911
|
+
currencyLocked?: boolean;
|
|
912
|
+
/**
|
|
913
|
+
* Number of orders placed.
|
|
914
|
+
* @readonly
|
|
915
|
+
*/
|
|
916
|
+
totalOrders?: number;
|
|
917
|
+
/**
|
|
918
|
+
* Total balance of confirmed transactions.
|
|
919
|
+
* @readonly
|
|
920
|
+
*/
|
|
921
|
+
totalSales?: EventsMoney;
|
|
922
|
+
}
|
|
923
|
+
interface GuestListSettings {
|
|
924
|
+
/** Whether the guest list is public for all guests. */
|
|
925
|
+
displayedPublicly?: boolean;
|
|
926
|
+
}
|
|
927
|
+
interface OnlineConferencing {
|
|
928
|
+
/** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
|
|
929
|
+
enabled?: boolean;
|
|
930
|
+
/**
|
|
931
|
+
* Conference host ID.
|
|
932
|
+
* @format GUID
|
|
933
|
+
*/
|
|
934
|
+
providerId?: string | null;
|
|
935
|
+
/** Conference type. */
|
|
936
|
+
type?: ConferenceTypeTypeWithLiterals;
|
|
937
|
+
/** Online conferencing session information. */
|
|
938
|
+
session?: OnlineConferencingSession;
|
|
939
|
+
}
|
|
940
|
+
declare enum ConferenceTypeType {
|
|
941
|
+
/** Default value. This value is unused */
|
|
942
|
+
UNKNOWN_CONFERENCE_TYPE = "UNKNOWN_CONFERENCE_TYPE",
|
|
943
|
+
/** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */
|
|
944
|
+
MEETING = "MEETING",
|
|
945
|
+
/** Guests can only watch the conference. */
|
|
946
|
+
WEBINAR = "WEBINAR"
|
|
947
|
+
}
|
|
948
|
+
/** @enumType */
|
|
949
|
+
type ConferenceTypeTypeWithLiterals = ConferenceTypeType | 'UNKNOWN_CONFERENCE_TYPE' | 'MEETING' | 'WEBINAR';
|
|
950
|
+
interface OnlineConferencingSession {
|
|
951
|
+
/**
|
|
952
|
+
* Link for the event host to start the online conference session.
|
|
953
|
+
* @readonly
|
|
954
|
+
*/
|
|
955
|
+
hostLink?: string;
|
|
956
|
+
/**
|
|
957
|
+
* Link for guests to join the online conference session.
|
|
958
|
+
* @readonly
|
|
959
|
+
*/
|
|
960
|
+
guestLink?: string;
|
|
961
|
+
/**
|
|
962
|
+
* Password required to join the online conferencing session (when relevant).
|
|
963
|
+
* @readonly
|
|
964
|
+
*/
|
|
965
|
+
password?: string | null;
|
|
966
|
+
/**
|
|
967
|
+
* Whether the session was created successfully on the event host side.
|
|
968
|
+
* @readonly
|
|
969
|
+
*/
|
|
970
|
+
sessionCreated?: boolean | null;
|
|
971
|
+
/**
|
|
972
|
+
* Unique session ID.
|
|
973
|
+
* @readonly
|
|
974
|
+
*/
|
|
975
|
+
sessionId?: string | null;
|
|
976
|
+
}
|
|
977
|
+
interface SeoSettings {
|
|
978
|
+
/**
|
|
979
|
+
* URL slug.
|
|
980
|
+
* @maxLength 130
|
|
981
|
+
*/
|
|
982
|
+
slug?: string;
|
|
983
|
+
/** Advanced SEO data. */
|
|
984
|
+
advancedSeoData?: SeoSchema;
|
|
985
|
+
/**
|
|
986
|
+
* Whether the slug is hidden from the SEO Site Map.
|
|
987
|
+
* @readonly
|
|
988
|
+
*/
|
|
989
|
+
hidden?: boolean | null;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
993
|
+
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
994
|
+
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
995
|
+
*/
|
|
996
|
+
interface SeoSchema {
|
|
997
|
+
/** SEO tag information. */
|
|
998
|
+
tags?: Tag[];
|
|
999
|
+
/** SEO general settings. */
|
|
1000
|
+
settings?: Settings;
|
|
1001
|
+
}
|
|
1002
|
+
interface Keyword {
|
|
1003
|
+
/** Keyword value. */
|
|
1004
|
+
term?: string;
|
|
1005
|
+
/** Whether the keyword is the main focus keyword. */
|
|
1006
|
+
isMain?: boolean;
|
|
1007
|
+
/**
|
|
1008
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1009
|
+
* @maxLength 1000
|
|
1010
|
+
*/
|
|
1011
|
+
origin?: string | null;
|
|
1012
|
+
}
|
|
1013
|
+
interface Tag {
|
|
1014
|
+
/**
|
|
1015
|
+
* SEO tag type.
|
|
1016
|
+
*
|
|
1017
|
+
*
|
|
1018
|
+
* Supported values: `title`, `meta`, `script`, `link`.
|
|
1019
|
+
*/
|
|
1020
|
+
type?: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
|
|
1023
|
+
* For example: `{"name": "description", "content": "the description itself"}`.
|
|
1024
|
+
*/
|
|
1025
|
+
props?: Record<string, any> | null;
|
|
1026
|
+
/** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
|
|
1027
|
+
meta?: Record<string, any> | null;
|
|
1028
|
+
/** SEO tag inner content. For example, `<title> inner content </title>`. */
|
|
1029
|
+
children?: string;
|
|
1030
|
+
/** Whether the tag is a custom tag. */
|
|
1031
|
+
custom?: boolean;
|
|
1032
|
+
/** Whether the tag is disabled. */
|
|
1033
|
+
disabled?: boolean;
|
|
1034
|
+
}
|
|
1035
|
+
interface Settings {
|
|
1036
|
+
/**
|
|
1037
|
+
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1038
|
+
*
|
|
1039
|
+
*
|
|
1040
|
+
* Default: `false` (Auto Redirect is enabled.)
|
|
1041
|
+
*/
|
|
1042
|
+
preventAutoRedirect?: boolean;
|
|
1043
|
+
/**
|
|
1044
|
+
* User-selected keyword terms for a specific page.
|
|
1045
|
+
* @maxSize 5
|
|
1046
|
+
*/
|
|
1047
|
+
keywords?: Keyword[];
|
|
1048
|
+
}
|
|
1049
|
+
interface AgendaSettings {
|
|
1050
|
+
/** Whether the schedule is enabled for the event. */
|
|
1051
|
+
enabled?: boolean;
|
|
1052
|
+
/**
|
|
1053
|
+
* Schedule page URL.
|
|
1054
|
+
* @readonly
|
|
1055
|
+
*/
|
|
1056
|
+
pageUrl?: PageUrl;
|
|
1057
|
+
}
|
|
1058
|
+
interface V3EventDisplaySettings {
|
|
1059
|
+
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1060
|
+
hideEventDetailsButton?: boolean | null;
|
|
1061
|
+
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1062
|
+
hideEventDetailsPage?: boolean | null;
|
|
1063
|
+
}
|
|
1064
|
+
interface RichContent {
|
|
1065
|
+
/** Node objects representing a rich content document. */
|
|
1066
|
+
nodes?: Node[];
|
|
1067
|
+
/** Object metadata. */
|
|
1068
|
+
metadata?: Metadata;
|
|
1069
|
+
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1070
|
+
documentStyle?: DocumentStyle;
|
|
1071
|
+
}
|
|
1072
|
+
interface Node extends NodeDataOneOf {
|
|
1073
|
+
/** Data for a button node. */
|
|
1074
|
+
buttonData?: ButtonData;
|
|
1075
|
+
/** Data for a code block node. */
|
|
1076
|
+
codeBlockData?: CodeBlockData;
|
|
1077
|
+
/** Data for a divider node. */
|
|
1078
|
+
dividerData?: DividerData;
|
|
1079
|
+
/** Data for a file node. */
|
|
1080
|
+
fileData?: FileData;
|
|
1081
|
+
/** Data for a gallery node. */
|
|
1082
|
+
galleryData?: GalleryData;
|
|
1083
|
+
/** Data for a GIF node. */
|
|
1084
|
+
gifData?: GIFData;
|
|
1085
|
+
/** Data for a heading node. */
|
|
1086
|
+
headingData?: HeadingData;
|
|
1087
|
+
/** Data for an embedded HTML node. */
|
|
1088
|
+
htmlData?: HTMLData;
|
|
1089
|
+
/** Data for an image node. */
|
|
1090
|
+
imageData?: ImageData;
|
|
1091
|
+
/** Data for a link preview node. */
|
|
1092
|
+
linkPreviewData?: LinkPreviewData;
|
|
1093
|
+
/** @deprecated */
|
|
1094
|
+
mapData?: MapData;
|
|
1095
|
+
/** Data for a paragraph node. */
|
|
1096
|
+
paragraphData?: ParagraphData;
|
|
1097
|
+
/** Data for a poll node. */
|
|
1098
|
+
pollData?: PollData;
|
|
1099
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
1100
|
+
textData?: TextData;
|
|
1101
|
+
/** Data for an app embed node. */
|
|
1102
|
+
appEmbedData?: AppEmbedData;
|
|
1103
|
+
/** Data for a video node. */
|
|
1104
|
+
videoData?: VideoData;
|
|
1105
|
+
/** Data for an oEmbed node. */
|
|
1106
|
+
embedData?: EmbedData;
|
|
1107
|
+
/** Data for a collapsible list node. */
|
|
1108
|
+
collapsibleListData?: CollapsibleListData;
|
|
1109
|
+
/** Data for a table node. */
|
|
1110
|
+
tableData?: TableData;
|
|
1111
|
+
/** Data for a table cell node. */
|
|
1112
|
+
tableCellData?: TableCellData;
|
|
1113
|
+
/** Data for a custom external node. */
|
|
1114
|
+
externalData?: Record<string, any> | null;
|
|
1115
|
+
/** Data for an audio node. */
|
|
1116
|
+
audioData?: AudioData;
|
|
1117
|
+
/** Data for an ordered list node. */
|
|
1118
|
+
orderedListData?: OrderedListData;
|
|
1119
|
+
/** Data for a bulleted list node. */
|
|
1120
|
+
bulletedListData?: BulletedListData;
|
|
1121
|
+
/** Data for a block quote node. */
|
|
1122
|
+
blockquoteData?: BlockquoteData;
|
|
1123
|
+
/** Data for a caption node. */
|
|
1124
|
+
captionData?: CaptionData;
|
|
1125
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1126
|
+
layoutCellData?: LayoutCellData;
|
|
1127
|
+
/** 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. */
|
|
1128
|
+
type?: NodeTypeWithLiterals;
|
|
1129
|
+
/** Node ID. */
|
|
1130
|
+
id?: string;
|
|
1131
|
+
/** A list of child nodes. */
|
|
1132
|
+
nodes?: Node[];
|
|
1133
|
+
/** Padding and background color styling for the node. */
|
|
1134
|
+
style?: NodeStyle;
|
|
1135
|
+
}
|
|
1136
|
+
/** @oneof */
|
|
1137
|
+
interface NodeDataOneOf {
|
|
1138
|
+
/** Data for a button node. */
|
|
1139
|
+
buttonData?: ButtonData;
|
|
1140
|
+
/** Data for a code block node. */
|
|
1141
|
+
codeBlockData?: CodeBlockData;
|
|
1142
|
+
/** Data for a divider node. */
|
|
1143
|
+
dividerData?: DividerData;
|
|
1144
|
+
/** Data for a file node. */
|
|
1145
|
+
fileData?: FileData;
|
|
1146
|
+
/** Data for a gallery node. */
|
|
1147
|
+
galleryData?: GalleryData;
|
|
1148
|
+
/** Data for a GIF node. */
|
|
1149
|
+
gifData?: GIFData;
|
|
1150
|
+
/** Data for a heading node. */
|
|
1151
|
+
headingData?: HeadingData;
|
|
1152
|
+
/** Data for an embedded HTML node. */
|
|
1153
|
+
htmlData?: HTMLData;
|
|
1154
|
+
/** Data for an image node. */
|
|
1155
|
+
imageData?: ImageData;
|
|
1156
|
+
/** Data for a link preview node. */
|
|
1157
|
+
linkPreviewData?: LinkPreviewData;
|
|
1158
|
+
/** @deprecated */
|
|
1159
|
+
mapData?: MapData;
|
|
1160
|
+
/** Data for a paragraph node. */
|
|
1161
|
+
paragraphData?: ParagraphData;
|
|
1162
|
+
/** Data for a poll node. */
|
|
1163
|
+
pollData?: PollData;
|
|
1164
|
+
/** Data for a text node. Used to apply decorations to text. */
|
|
1165
|
+
textData?: TextData;
|
|
1166
|
+
/** Data for an app embed node. */
|
|
1167
|
+
appEmbedData?: AppEmbedData;
|
|
1168
|
+
/** Data for a video node. */
|
|
1169
|
+
videoData?: VideoData;
|
|
1170
|
+
/** Data for an oEmbed node. */
|
|
1171
|
+
embedData?: EmbedData;
|
|
1172
|
+
/** Data for a collapsible list node. */
|
|
1173
|
+
collapsibleListData?: CollapsibleListData;
|
|
1174
|
+
/** Data for a table node. */
|
|
1175
|
+
tableData?: TableData;
|
|
1176
|
+
/** Data for a table cell node. */
|
|
1177
|
+
tableCellData?: TableCellData;
|
|
1178
|
+
/** Data for a custom external node. */
|
|
1179
|
+
externalData?: Record<string, any> | null;
|
|
1180
|
+
/** Data for an audio node. */
|
|
1181
|
+
audioData?: AudioData;
|
|
1182
|
+
/** Data for an ordered list node. */
|
|
1183
|
+
orderedListData?: OrderedListData;
|
|
1184
|
+
/** Data for a bulleted list node. */
|
|
1185
|
+
bulletedListData?: BulletedListData;
|
|
1186
|
+
/** Data for a block quote node. */
|
|
1187
|
+
blockquoteData?: BlockquoteData;
|
|
1188
|
+
/** Data for a caption node. */
|
|
1189
|
+
captionData?: CaptionData;
|
|
1190
|
+
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1191
|
+
layoutCellData?: LayoutCellData;
|
|
1192
|
+
}
|
|
1193
|
+
declare enum NodeType {
|
|
1194
|
+
PARAGRAPH = "PARAGRAPH",
|
|
1195
|
+
TEXT = "TEXT",
|
|
1196
|
+
HEADING = "HEADING",
|
|
1197
|
+
BULLETED_LIST = "BULLETED_LIST",
|
|
1198
|
+
ORDERED_LIST = "ORDERED_LIST",
|
|
1199
|
+
LIST_ITEM = "LIST_ITEM",
|
|
1200
|
+
BLOCKQUOTE = "BLOCKQUOTE",
|
|
1201
|
+
CODE_BLOCK = "CODE_BLOCK",
|
|
1202
|
+
VIDEO = "VIDEO",
|
|
1203
|
+
DIVIDER = "DIVIDER",
|
|
1204
|
+
FILE = "FILE",
|
|
1205
|
+
GALLERY = "GALLERY",
|
|
1206
|
+
GIF = "GIF",
|
|
1207
|
+
HTML = "HTML",
|
|
1208
|
+
IMAGE = "IMAGE",
|
|
1209
|
+
LINK_PREVIEW = "LINK_PREVIEW",
|
|
1210
|
+
/** @deprecated */
|
|
1211
|
+
MAP = "MAP",
|
|
1212
|
+
POLL = "POLL",
|
|
1213
|
+
APP_EMBED = "APP_EMBED",
|
|
1214
|
+
BUTTON = "BUTTON",
|
|
1215
|
+
COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
|
|
1216
|
+
TABLE = "TABLE",
|
|
1217
|
+
EMBED = "EMBED",
|
|
1218
|
+
COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
|
|
1219
|
+
COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
|
|
1220
|
+
COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
|
|
1221
|
+
TABLE_CELL = "TABLE_CELL",
|
|
1222
|
+
TABLE_ROW = "TABLE_ROW",
|
|
1223
|
+
EXTERNAL = "EXTERNAL",
|
|
1224
|
+
AUDIO = "AUDIO",
|
|
1225
|
+
CAPTION = "CAPTION",
|
|
1226
|
+
LAYOUT = "LAYOUT",
|
|
1227
|
+
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1228
|
+
}
|
|
1229
|
+
/** @enumType */
|
|
1230
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
1231
|
+
interface NodeStyle {
|
|
1232
|
+
/** The top padding value in pixels. */
|
|
1233
|
+
paddingTop?: string | null;
|
|
1234
|
+
/** The bottom padding value in pixels. */
|
|
1235
|
+
paddingBottom?: string | null;
|
|
1236
|
+
/** The background color as a hexadecimal value. */
|
|
1237
|
+
backgroundColor?: string | null;
|
|
1238
|
+
}
|
|
1239
|
+
interface ButtonData {
|
|
1240
|
+
/** Styling for the button's container. */
|
|
1241
|
+
containerData?: PluginContainerData;
|
|
1242
|
+
/** The button type. */
|
|
1243
|
+
type?: ButtonDataTypeWithLiterals;
|
|
1244
|
+
/** Styling for the button. */
|
|
1245
|
+
styles?: Styles;
|
|
1246
|
+
/** The text to display on the button. */
|
|
1247
|
+
text?: string | null;
|
|
1248
|
+
/** Button link details. */
|
|
1249
|
+
link?: Link;
|
|
1250
|
+
}
|
|
1251
|
+
interface Border {
|
|
1252
|
+
/**
|
|
1253
|
+
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1254
|
+
* @deprecated
|
|
1255
|
+
*/
|
|
1256
|
+
width?: number | null;
|
|
1257
|
+
/**
|
|
1258
|
+
* Deprecated: Use `borderRadius` in `styles` instead.
|
|
1259
|
+
* @deprecated
|
|
1260
|
+
*/
|
|
1261
|
+
radius?: number | null;
|
|
1262
|
+
}
|
|
1263
|
+
interface Colors {
|
|
1264
|
+
/**
|
|
1265
|
+
* Deprecated: Use `textColor` in `styles` instead.
|
|
1266
|
+
* @deprecated
|
|
1267
|
+
*/
|
|
1268
|
+
text?: string | null;
|
|
1269
|
+
/**
|
|
1270
|
+
* Deprecated: Use `borderColor` in `styles` instead.
|
|
1271
|
+
* @deprecated
|
|
1272
|
+
*/
|
|
1273
|
+
border?: string | null;
|
|
1274
|
+
/**
|
|
1275
|
+
* Deprecated: Use `backgroundColor` in `styles` instead.
|
|
1276
|
+
* @deprecated
|
|
1277
|
+
*/
|
|
1278
|
+
background?: string | null;
|
|
1279
|
+
}
|
|
1280
|
+
interface PluginContainerData {
|
|
1281
|
+
/** The width of the node when it's displayed. */
|
|
1282
|
+
width?: PluginContainerDataWidth;
|
|
1283
|
+
/** The node's alignment within its container. */
|
|
1284
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
1285
|
+
/** Spoiler cover settings for the node. */
|
|
1286
|
+
spoiler?: Spoiler;
|
|
1287
|
+
/** The height of the node when it's displayed. */
|
|
1288
|
+
height?: Height;
|
|
1289
|
+
/** 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`. */
|
|
1290
|
+
textWrap?: boolean | null;
|
|
1291
|
+
}
|
|
1292
|
+
declare enum WidthType {
|
|
1293
|
+
/** Width matches the content width */
|
|
1294
|
+
CONTENT = "CONTENT",
|
|
1295
|
+
/** Small Width */
|
|
1296
|
+
SMALL = "SMALL",
|
|
1297
|
+
/** Width will match the original asset width */
|
|
1298
|
+
ORIGINAL = "ORIGINAL",
|
|
1299
|
+
/** coast-to-coast display */
|
|
1300
|
+
FULL_WIDTH = "FULL_WIDTH"
|
|
1301
|
+
}
|
|
1302
|
+
/** @enumType */
|
|
1303
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
1304
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
1305
|
+
/**
|
|
1306
|
+
* One of the following predefined width options:
|
|
1307
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
1308
|
+
* `SMALL`: A small width.
|
|
1309
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1310
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1311
|
+
*/
|
|
1312
|
+
size?: WidthTypeWithLiterals;
|
|
1313
|
+
/** A custom width value in pixels. */
|
|
1314
|
+
custom?: string | null;
|
|
1315
|
+
}
|
|
1316
|
+
/** @oneof */
|
|
1317
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
1318
|
+
/**
|
|
1319
|
+
* One of the following predefined width options:
|
|
1320
|
+
* `CONTENT`: The width of the container matches the content width.
|
|
1321
|
+
* `SMALL`: A small width.
|
|
1322
|
+
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
1323
|
+
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
1324
|
+
*/
|
|
1325
|
+
size?: WidthTypeWithLiterals;
|
|
1326
|
+
/** A custom width value in pixels. */
|
|
1327
|
+
custom?: string | null;
|
|
1328
|
+
}
|
|
1329
|
+
declare enum PluginContainerDataAlignment {
|
|
1330
|
+
/** Center Alignment */
|
|
1331
|
+
CENTER = "CENTER",
|
|
1332
|
+
/** Left Alignment */
|
|
1333
|
+
LEFT = "LEFT",
|
|
1334
|
+
/** Right Alignment */
|
|
1335
|
+
RIGHT = "RIGHT"
|
|
1336
|
+
}
|
|
1337
|
+
/** @enumType */
|
|
1338
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1339
|
+
interface Spoiler {
|
|
1340
|
+
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
1341
|
+
enabled?: boolean | null;
|
|
1342
|
+
/** The description displayed on top of the spoiler cover. */
|
|
1343
|
+
description?: string | null;
|
|
1344
|
+
/** The text for the button used to remove the spoiler cover. */
|
|
1345
|
+
buttonText?: string | null;
|
|
1346
|
+
}
|
|
1347
|
+
interface Height {
|
|
1348
|
+
/** A custom height value in pixels. */
|
|
1349
|
+
custom?: string | null;
|
|
1350
|
+
}
|
|
1351
|
+
declare enum ButtonDataType {
|
|
1352
|
+
/** Regular link button */
|
|
1353
|
+
LINK = "LINK",
|
|
1354
|
+
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
1355
|
+
ACTION = "ACTION"
|
|
1356
|
+
}
|
|
1357
|
+
/** @enumType */
|
|
1358
|
+
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
1359
|
+
interface Styles {
|
|
1360
|
+
/**
|
|
1361
|
+
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
1362
|
+
* @deprecated
|
|
1363
|
+
*/
|
|
1364
|
+
border?: Border;
|
|
1365
|
+
/**
|
|
1366
|
+
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
|
|
1367
|
+
* @deprecated
|
|
1368
|
+
*/
|
|
1369
|
+
colors?: Colors;
|
|
1370
|
+
/** Border width in pixels. */
|
|
1371
|
+
borderWidth?: number | null;
|
|
1372
|
+
/**
|
|
1373
|
+
* Deprecated: Use `borderWidth` for normal/hover states instead.
|
|
1374
|
+
* @deprecated
|
|
1375
|
+
*/
|
|
1376
|
+
borderWidthHover?: number | null;
|
|
1377
|
+
/** Border radius in pixels. */
|
|
1378
|
+
borderRadius?: number | null;
|
|
1379
|
+
/**
|
|
1380
|
+
* Border color as a hexadecimal value.
|
|
1381
|
+
* @format COLOR_HEX
|
|
1382
|
+
*/
|
|
1383
|
+
borderColor?: string | null;
|
|
1384
|
+
/**
|
|
1385
|
+
* Border color as a hexadecimal value (hover state).
|
|
1386
|
+
* @format COLOR_HEX
|
|
1387
|
+
*/
|
|
1388
|
+
borderColorHover?: string | null;
|
|
1389
|
+
/**
|
|
1390
|
+
* Text color as a hexadecimal value.
|
|
1391
|
+
* @format COLOR_HEX
|
|
1392
|
+
*/
|
|
1393
|
+
textColor?: string | null;
|
|
1394
|
+
/**
|
|
1395
|
+
* Text color as a hexadecimal value (hover state).
|
|
1396
|
+
* @format COLOR_HEX
|
|
1397
|
+
*/
|
|
1398
|
+
textColorHover?: string | null;
|
|
1399
|
+
/**
|
|
1400
|
+
* Background color as a hexadecimal value.
|
|
1401
|
+
* @format COLOR_HEX
|
|
1402
|
+
*/
|
|
1403
|
+
backgroundColor?: string | null;
|
|
1404
|
+
/**
|
|
1405
|
+
* Background color as a hexadecimal value (hover state).
|
|
1406
|
+
* @format COLOR_HEX
|
|
1407
|
+
*/
|
|
1408
|
+
backgroundColorHover?: string | null;
|
|
1409
|
+
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
1410
|
+
buttonSize?: string | null;
|
|
1411
|
+
}
|
|
1412
|
+
interface Link extends LinkDataOneOf {
|
|
1413
|
+
/** The absolute URL for the linked document. */
|
|
1414
|
+
url?: string;
|
|
1415
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
1416
|
+
anchor?: string;
|
|
1417
|
+
/**
|
|
1418
|
+
* he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
|
|
1419
|
+
* `SELF` - Default. Opens the linked document in the same frame as the link.
|
|
1420
|
+
* `BLANK` - Opens the linked document in a new browser tab or window.
|
|
1421
|
+
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
1422
|
+
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
1423
|
+
*/
|
|
1424
|
+
target?: TargetWithLiterals;
|
|
1425
|
+
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
1426
|
+
rel?: Rel;
|
|
1427
|
+
/** A serialized object used for a custom or external link panel. */
|
|
1428
|
+
customData?: string | null;
|
|
1429
|
+
}
|
|
1430
|
+
/** @oneof */
|
|
1431
|
+
interface LinkDataOneOf {
|
|
1432
|
+
/** The absolute URL for the linked document. */
|
|
1433
|
+
url?: string;
|
|
1434
|
+
/** The target node's ID. Used for linking to another node in this object. */
|
|
1435
|
+
anchor?: string;
|
|
1436
|
+
}
|
|
1437
|
+
declare enum Target {
|
|
1438
|
+
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
1439
|
+
SELF = "SELF",
|
|
1440
|
+
/** Opens the linked document in a new window or tab */
|
|
1441
|
+
BLANK = "BLANK",
|
|
1442
|
+
/** Opens the linked document in the parent frame */
|
|
1443
|
+
PARENT = "PARENT",
|
|
1444
|
+
/** Opens the linked document in the full body of the window */
|
|
1445
|
+
TOP = "TOP"
|
|
1446
|
+
}
|
|
1447
|
+
/** @enumType */
|
|
1448
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
1449
|
+
interface Rel {
|
|
1450
|
+
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
1451
|
+
nofollow?: boolean | null;
|
|
1452
|
+
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
1453
|
+
sponsored?: boolean | null;
|
|
1454
|
+
/** 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`. */
|
|
1455
|
+
ugc?: boolean | null;
|
|
1456
|
+
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
1457
|
+
noreferrer?: boolean | null;
|
|
1458
|
+
}
|
|
1459
|
+
interface CodeBlockData {
|
|
1460
|
+
/** Styling for the code block's text. */
|
|
1461
|
+
textStyle?: TextStyle;
|
|
1462
|
+
}
|
|
1463
|
+
interface TextStyle {
|
|
1464
|
+
/** Text alignment. Defaults to `AUTO`. */
|
|
1465
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
1466
|
+
/** 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. */
|
|
1467
|
+
lineHeight?: string | null;
|
|
1468
|
+
}
|
|
1469
|
+
declare enum TextAlignment {
|
|
1470
|
+
/** browser default, eqivalent to `initial` */
|
|
1471
|
+
AUTO = "AUTO",
|
|
1472
|
+
/** Left align */
|
|
1473
|
+
LEFT = "LEFT",
|
|
1474
|
+
/** Right align */
|
|
1475
|
+
RIGHT = "RIGHT",
|
|
1476
|
+
/** Center align */
|
|
1477
|
+
CENTER = "CENTER",
|
|
1478
|
+
/** 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 */
|
|
1479
|
+
JUSTIFY = "JUSTIFY"
|
|
1480
|
+
}
|
|
1481
|
+
/** @enumType */
|
|
1482
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
1483
|
+
interface DividerData {
|
|
1484
|
+
/** Styling for the divider's container. */
|
|
1485
|
+
containerData?: PluginContainerData;
|
|
1486
|
+
/** Divider line style. */
|
|
1487
|
+
lineStyle?: LineStyleWithLiterals;
|
|
1488
|
+
/** Divider width. */
|
|
1489
|
+
width?: WidthWithLiterals;
|
|
1490
|
+
/** Divider alignment. */
|
|
1491
|
+
alignment?: AlignmentWithLiterals;
|
|
1492
|
+
}
|
|
1493
|
+
declare enum LineStyle {
|
|
1494
|
+
/** Single Line */
|
|
1495
|
+
SINGLE = "SINGLE",
|
|
1496
|
+
/** Double Line */
|
|
1497
|
+
DOUBLE = "DOUBLE",
|
|
1498
|
+
/** Dashed Line */
|
|
1499
|
+
DASHED = "DASHED",
|
|
1500
|
+
/** Dotted Line */
|
|
1501
|
+
DOTTED = "DOTTED"
|
|
1502
|
+
}
|
|
1503
|
+
/** @enumType */
|
|
1504
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
1505
|
+
declare enum Width {
|
|
1506
|
+
/** Large line */
|
|
1507
|
+
LARGE = "LARGE",
|
|
1508
|
+
/** Medium line */
|
|
1509
|
+
MEDIUM = "MEDIUM",
|
|
1510
|
+
/** Small line */
|
|
1511
|
+
SMALL = "SMALL"
|
|
1512
|
+
}
|
|
1513
|
+
/** @enumType */
|
|
1514
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
1515
|
+
declare enum Alignment {
|
|
1516
|
+
/** Center alignment */
|
|
1517
|
+
CENTER = "CENTER",
|
|
1518
|
+
/** Left alignment */
|
|
1519
|
+
LEFT = "LEFT",
|
|
1520
|
+
/** Right alignment */
|
|
1521
|
+
RIGHT = "RIGHT"
|
|
1522
|
+
}
|
|
1523
|
+
/** @enumType */
|
|
1524
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
1525
|
+
interface FileData {
|
|
1526
|
+
/** Styling for the file's container. */
|
|
1527
|
+
containerData?: PluginContainerData;
|
|
1528
|
+
/** The source for the file's data. */
|
|
1529
|
+
src?: FileSource;
|
|
1530
|
+
/** File name. */
|
|
1531
|
+
name?: string | null;
|
|
1532
|
+
/** File type. */
|
|
1533
|
+
type?: string | null;
|
|
1534
|
+
/**
|
|
1535
|
+
* Use `sizeInKb` instead.
|
|
1536
|
+
* @deprecated
|
|
1537
|
+
*/
|
|
1538
|
+
size?: number | null;
|
|
1539
|
+
/** Settings for PDF files. */
|
|
1540
|
+
pdfSettings?: PDFSettings;
|
|
1541
|
+
/** File MIME type. */
|
|
1542
|
+
mimeType?: string | null;
|
|
1543
|
+
/** File path. */
|
|
1544
|
+
path?: string | null;
|
|
1545
|
+
/** File size in KB. */
|
|
1546
|
+
sizeInKb?: string | null;
|
|
1547
|
+
}
|
|
1548
|
+
declare enum ViewMode {
|
|
1549
|
+
/** No PDF view */
|
|
1550
|
+
NONE = "NONE",
|
|
1551
|
+
/** Full PDF view */
|
|
1552
|
+
FULL = "FULL",
|
|
1553
|
+
/** Mini PDF view */
|
|
1554
|
+
MINI = "MINI"
|
|
1555
|
+
}
|
|
1556
|
+
/** @enumType */
|
|
1557
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
1558
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
1559
|
+
/** The absolute URL for the file's source. */
|
|
1560
|
+
url?: string | null;
|
|
1561
|
+
/**
|
|
1562
|
+
* Custom ID. Use `id` instead.
|
|
1563
|
+
* @deprecated
|
|
1564
|
+
*/
|
|
1565
|
+
custom?: string | null;
|
|
1566
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1567
|
+
id?: string | null;
|
|
1568
|
+
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
1569
|
+
private?: boolean | null;
|
|
1570
|
+
}
|
|
1571
|
+
/** @oneof */
|
|
1572
|
+
interface FileSourceDataOneOf {
|
|
1573
|
+
/** The absolute URL for the file's source. */
|
|
1574
|
+
url?: string | null;
|
|
1575
|
+
/**
|
|
1576
|
+
* Custom ID. Use `id` instead.
|
|
1577
|
+
* @deprecated
|
|
1578
|
+
*/
|
|
1579
|
+
custom?: string | null;
|
|
1580
|
+
/** An ID that's resolved to a URL by a resolver function. */
|
|
1581
|
+
id?: string | null;
|
|
1582
|
+
}
|
|
1583
|
+
interface PDFSettings {
|
|
1584
|
+
/**
|
|
1585
|
+
* PDF view mode. One of the following:
|
|
1586
|
+
* `NONE` : The PDF isn't displayed.
|
|
1587
|
+
* `FULL` : A full page view of the PDF is displayed.
|
|
1588
|
+
* `MINI` : A mini view of the PDF is displayed.
|
|
1589
|
+
*/
|
|
1590
|
+
viewMode?: ViewModeWithLiterals;
|
|
1591
|
+
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
1592
|
+
disableDownload?: boolean | null;
|
|
1593
|
+
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
1594
|
+
disablePrint?: boolean | null;
|
|
1595
|
+
}
|
|
1596
|
+
interface GalleryData {
|
|
1597
|
+
/** Styling for the gallery's container. */
|
|
1598
|
+
containerData?: PluginContainerData;
|
|
1599
|
+
/** The items in the gallery. */
|
|
1600
|
+
items?: Item[];
|
|
1601
|
+
/** Options for defining the gallery's appearance. */
|
|
1602
|
+
options?: GalleryOptions;
|
|
1603
|
+
/** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
|
|
1604
|
+
disableExpand?: boolean | null;
|
|
1605
|
+
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
1606
|
+
disableDownload?: boolean | null;
|
|
1607
|
+
}
|
|
1608
|
+
interface Media {
|
|
1609
|
+
/** The source for the media's data. */
|
|
1610
|
+
src?: FileSource;
|
|
1611
|
+
/** Media width in pixels. */
|
|
1612
|
+
width?: number | null;
|
|
1613
|
+
/** Media height in pixels. */
|
|
1614
|
+
height?: number | null;
|
|
1615
|
+
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
1616
|
+
duration?: number | null;
|
|
1617
|
+
}
|
|
1618
|
+
interface ItemImage {
|
|
1619
|
+
/** Image file details. */
|
|
1620
|
+
media?: Media;
|
|
1621
|
+
/** Link details for images that are links. */
|
|
1622
|
+
link?: Link;
|
|
1623
|
+
}
|
|
1624
|
+
interface Video {
|
|
1625
|
+
/** Video file details. */
|
|
1626
|
+
media?: Media;
|
|
1627
|
+
/** Video thumbnail file details. */
|
|
1628
|
+
thumbnail?: Media;
|
|
1629
|
+
}
|
|
1630
|
+
interface Item extends ItemDataOneOf {
|
|
1631
|
+
/** An image item. */
|
|
1632
|
+
image?: ItemImage;
|
|
1633
|
+
/** A video item. */
|
|
1634
|
+
video?: Video;
|
|
1635
|
+
/** Item title. */
|
|
1636
|
+
title?: string | null;
|
|
1637
|
+
/** Item's alternative text. */
|
|
1638
|
+
altText?: string | null;
|
|
1639
|
+
}
|
|
1640
|
+
/** @oneof */
|
|
1641
|
+
interface ItemDataOneOf {
|
|
1642
|
+
/** An image item. */
|
|
1643
|
+
image?: ItemImage;
|
|
1644
|
+
/** A video item. */
|
|
1645
|
+
video?: Video;
|
|
1646
|
+
}
|
|
1647
|
+
interface GalleryOptions {
|
|
1648
|
+
/** Gallery layout. */
|
|
1649
|
+
layout?: Layout;
|
|
1650
|
+
/** Styling for gallery items. */
|
|
1651
|
+
item?: ItemStyle;
|
|
1652
|
+
/** Styling for gallery thumbnail images. */
|
|
1653
|
+
thumbnails?: Thumbnails;
|
|
1654
|
+
}
|
|
1655
|
+
declare enum LayoutType {
|
|
1656
|
+
/** Collage type */
|
|
1657
|
+
COLLAGE = "COLLAGE",
|
|
1658
|
+
/** Masonry type */
|
|
1659
|
+
MASONRY = "MASONRY",
|
|
1660
|
+
/** Grid type */
|
|
1661
|
+
GRID = "GRID",
|
|
1662
|
+
/** Thumbnail type */
|
|
1663
|
+
THUMBNAIL = "THUMBNAIL",
|
|
1664
|
+
/** Slider type */
|
|
1665
|
+
SLIDER = "SLIDER",
|
|
1666
|
+
/** Slideshow type */
|
|
1667
|
+
SLIDESHOW = "SLIDESHOW",
|
|
1668
|
+
/** Panorama type */
|
|
1669
|
+
PANORAMA = "PANORAMA",
|
|
1670
|
+
/** Column type */
|
|
1671
|
+
COLUMN = "COLUMN",
|
|
1672
|
+
/** Magic type */
|
|
1673
|
+
MAGIC = "MAGIC",
|
|
1674
|
+
/** Fullsize images type */
|
|
1675
|
+
FULLSIZE = "FULLSIZE"
|
|
1676
|
+
}
|
|
1677
|
+
/** @enumType */
|
|
1678
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
1679
|
+
declare enum Orientation {
|
|
1680
|
+
/** Rows Orientation */
|
|
1681
|
+
ROWS = "ROWS",
|
|
1682
|
+
/** Columns Orientation */
|
|
1683
|
+
COLUMNS = "COLUMNS"
|
|
1684
|
+
}
|
|
1685
|
+
/** @enumType */
|
|
1686
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
1687
|
+
declare enum Crop {
|
|
1688
|
+
/** Crop to fill */
|
|
1689
|
+
FILL = "FILL",
|
|
1690
|
+
/** Crop to fit */
|
|
1691
|
+
FIT = "FIT"
|
|
1692
|
+
}
|
|
1693
|
+
/** @enumType */
|
|
1694
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
1695
|
+
declare enum ThumbnailsAlignment {
|
|
1696
|
+
/** Top alignment */
|
|
1697
|
+
TOP = "TOP",
|
|
1698
|
+
/** Right alignment */
|
|
1699
|
+
RIGHT = "RIGHT",
|
|
1700
|
+
/** Bottom alignment */
|
|
1701
|
+
BOTTOM = "BOTTOM",
|
|
1702
|
+
/** Left alignment */
|
|
1703
|
+
LEFT = "LEFT",
|
|
1704
|
+
/** No thumbnail */
|
|
1705
|
+
NONE = "NONE"
|
|
1706
|
+
}
|
|
1707
|
+
/** @enumType */
|
|
1708
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
1709
|
+
interface Layout {
|
|
1710
|
+
/** Gallery layout type. */
|
|
1711
|
+
type?: LayoutTypeWithLiterals;
|
|
1712
|
+
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
1713
|
+
horizontalScroll?: boolean | null;
|
|
1714
|
+
/** Gallery orientation. */
|
|
1715
|
+
orientation?: OrientationWithLiterals;
|
|
1716
|
+
/** The number of columns to display on full size screens. */
|
|
1717
|
+
numberOfColumns?: number | null;
|
|
1718
|
+
/** The number of columns to display on mobile screens. */
|
|
1719
|
+
mobileNumberOfColumns?: number | null;
|
|
1720
|
+
}
|
|
1721
|
+
interface ItemStyle {
|
|
1722
|
+
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
1723
|
+
targetSize?: number | null;
|
|
1724
|
+
/** Item ratio */
|
|
1725
|
+
ratio?: number | null;
|
|
1726
|
+
/** Sets how item images are cropped. */
|
|
1727
|
+
crop?: CropWithLiterals;
|
|
1728
|
+
/** The spacing between items in pixels. */
|
|
1729
|
+
spacing?: number | null;
|
|
1730
|
+
}
|
|
1731
|
+
interface Thumbnails {
|
|
1732
|
+
/** Thumbnail alignment. */
|
|
1733
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
1734
|
+
/** Spacing between thumbnails in pixels. */
|
|
1735
|
+
spacing?: number | null;
|
|
1736
|
+
}
|
|
1737
|
+
interface GIFData {
|
|
1738
|
+
/** Styling for the GIF's container. */
|
|
1739
|
+
containerData?: PluginContainerData;
|
|
1740
|
+
/** The source of the full size GIF. */
|
|
1741
|
+
original?: GIF;
|
|
1742
|
+
/** The source of the downsized GIF. */
|
|
1743
|
+
downsized?: GIF;
|
|
1744
|
+
/** Height in pixels. */
|
|
1745
|
+
height?: number;
|
|
1746
|
+
/** Width in pixels. */
|
|
1747
|
+
width?: number;
|
|
1748
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
1749
|
+
gifType?: GIFTypeWithLiterals;
|
|
1750
|
+
}
|
|
1751
|
+
interface GIF {
|
|
1752
|
+
/**
|
|
1753
|
+
* GIF format URL.
|
|
1754
|
+
* @format WEB_URL
|
|
1755
|
+
*/
|
|
1756
|
+
gif?: string | null;
|
|
1757
|
+
/**
|
|
1758
|
+
* MP4 format URL.
|
|
1759
|
+
* @format WEB_URL
|
|
1760
|
+
*/
|
|
1761
|
+
mp4?: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* Thumbnail URL.
|
|
1764
|
+
* @format WEB_URL
|
|
1765
|
+
*/
|
|
1766
|
+
still?: string | null;
|
|
1767
|
+
}
|
|
1768
|
+
declare enum GIFType {
|
|
1769
|
+
NORMAL = "NORMAL",
|
|
1770
|
+
STICKER = "STICKER"
|
|
1771
|
+
}
|
|
1772
|
+
/** @enumType */
|
|
1773
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
1774
|
+
interface HeadingData {
|
|
1775
|
+
/** Heading level from 1-6. */
|
|
1776
|
+
level?: number;
|
|
1777
|
+
/** Styling for the heading text. */
|
|
1778
|
+
textStyle?: TextStyle;
|
|
1779
|
+
/** Indentation level from 1-4. */
|
|
1780
|
+
indentation?: number | null;
|
|
1781
|
+
}
|
|
1782
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
1783
|
+
/** The URL for the HTML code for the node. */
|
|
1784
|
+
url?: string;
|
|
1785
|
+
/** The HTML code for the node. */
|
|
1786
|
+
html?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1789
|
+
* @deprecated
|
|
1790
|
+
*/
|
|
1791
|
+
isAdsense?: boolean | null;
|
|
1792
|
+
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
1793
|
+
containerData?: PluginContainerData;
|
|
1794
|
+
/** The type of HTML code. */
|
|
1795
|
+
source?: SourceWithLiterals;
|
|
1796
|
+
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
1797
|
+
autoHeight?: boolean | null;
|
|
1798
|
+
}
|
|
1799
|
+
/** @oneof */
|
|
1800
|
+
interface HTMLDataDataOneOf {
|
|
1801
|
+
/** The URL for the HTML code for the node. */
|
|
1802
|
+
url?: string;
|
|
1803
|
+
/** The HTML code for the node. */
|
|
1804
|
+
html?: string;
|
|
1805
|
+
/**
|
|
1806
|
+
* Whether this is an AdSense element. Use `source` instead.
|
|
1807
|
+
* @deprecated
|
|
1808
|
+
*/
|
|
1809
|
+
isAdsense?: boolean | null;
|
|
1810
|
+
}
|
|
1811
|
+
declare enum Source {
|
|
1812
|
+
HTML = "HTML",
|
|
1813
|
+
ADSENSE = "ADSENSE"
|
|
1814
|
+
}
|
|
1815
|
+
/** @enumType */
|
|
1816
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
1817
|
+
interface ImageData {
|
|
1818
|
+
/** Styling for the image's container. */
|
|
1819
|
+
containerData?: PluginContainerData;
|
|
1820
|
+
/** Image file details. */
|
|
1821
|
+
image?: Media;
|
|
1822
|
+
/** Link details for images that are links. */
|
|
1823
|
+
link?: Link;
|
|
1824
|
+
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
|
|
1825
|
+
disableExpand?: boolean | null;
|
|
1826
|
+
/** Image's alternative text. */
|
|
1827
|
+
altText?: string | null;
|
|
1828
|
+
/**
|
|
1829
|
+
* Deprecated: use Caption node instead.
|
|
1830
|
+
* @deprecated
|
|
1831
|
+
*/
|
|
1832
|
+
caption?: string | null;
|
|
1833
|
+
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
1834
|
+
disableDownload?: boolean | null;
|
|
1835
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1836
|
+
decorative?: boolean | null;
|
|
1837
|
+
/** Styling for the image. */
|
|
1838
|
+
styles?: ImageDataStyles;
|
|
1839
|
+
}
|
|
1840
|
+
interface StylesBorder {
|
|
1841
|
+
/** Border width in pixels. */
|
|
1842
|
+
width?: number | null;
|
|
1843
|
+
/**
|
|
1844
|
+
* Border color as a hexadecimal value.
|
|
1845
|
+
* @format COLOR_HEX
|
|
1846
|
+
*/
|
|
1847
|
+
color?: string | null;
|
|
1848
|
+
/** Border radius in pixels. */
|
|
1849
|
+
radius?: number | null;
|
|
1850
|
+
}
|
|
1851
|
+
interface ImageDataStyles {
|
|
1852
|
+
/** Border attributes. */
|
|
1853
|
+
border?: StylesBorder;
|
|
1854
|
+
}
|
|
1855
|
+
interface LinkPreviewData {
|
|
1856
|
+
/** Styling for the link preview's container. */
|
|
1857
|
+
containerData?: PluginContainerData;
|
|
1858
|
+
/** Link details. */
|
|
1859
|
+
link?: Link;
|
|
1860
|
+
/** Preview title. */
|
|
1861
|
+
title?: string | null;
|
|
1862
|
+
/** Preview thumbnail URL. */
|
|
1863
|
+
thumbnailUrl?: string | null;
|
|
1864
|
+
/** Preview description. */
|
|
1865
|
+
description?: string | null;
|
|
1866
|
+
/** The preview content as HTML. */
|
|
1867
|
+
html?: string | null;
|
|
1868
|
+
/** Styling for the link preview. */
|
|
1869
|
+
styles?: LinkPreviewDataStyles;
|
|
1870
|
+
}
|
|
1871
|
+
declare enum Position {
|
|
1872
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1873
|
+
START = "START",
|
|
1874
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1875
|
+
END = "END",
|
|
1876
|
+
/** Thumbnail positioned at the top */
|
|
1877
|
+
TOP = "TOP",
|
|
1878
|
+
/** Thumbnail hidden and not displayed */
|
|
1879
|
+
HIDDEN = "HIDDEN"
|
|
1880
|
+
}
|
|
1881
|
+
/** @enumType */
|
|
1882
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1883
|
+
interface LinkPreviewDataStyles {
|
|
1884
|
+
/**
|
|
1885
|
+
* Background color as a hexadecimal value.
|
|
1886
|
+
* @format COLOR_HEX
|
|
1887
|
+
*/
|
|
1888
|
+
backgroundColor?: string | null;
|
|
1889
|
+
/**
|
|
1890
|
+
* Title color as a hexadecimal value.
|
|
1891
|
+
* @format COLOR_HEX
|
|
1892
|
+
*/
|
|
1893
|
+
titleColor?: string | null;
|
|
1894
|
+
/**
|
|
1895
|
+
* Subtitle color as a hexadecimal value.
|
|
1896
|
+
* @format COLOR_HEX
|
|
1897
|
+
*/
|
|
1898
|
+
subtitleColor?: string | null;
|
|
1899
|
+
/**
|
|
1900
|
+
* Link color as a hexadecimal value.
|
|
1901
|
+
* @format COLOR_HEX
|
|
1902
|
+
*/
|
|
1903
|
+
linkColor?: string | null;
|
|
1904
|
+
/** Border width in pixels. */
|
|
1905
|
+
borderWidth?: number | null;
|
|
1906
|
+
/** Border radius in pixels. */
|
|
1907
|
+
borderRadius?: number | null;
|
|
1908
|
+
/**
|
|
1909
|
+
* Border color as a hexadecimal value.
|
|
1910
|
+
* @format COLOR_HEX
|
|
1911
|
+
*/
|
|
1912
|
+
borderColor?: string | null;
|
|
1913
|
+
/** Position of thumbnail. Defaults to `START`. */
|
|
1914
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
1915
|
+
}
|
|
1916
|
+
interface MapData {
|
|
1917
|
+
/** Styling for the map's container. */
|
|
1918
|
+
containerData?: PluginContainerData;
|
|
1919
|
+
/** Map settings. */
|
|
1920
|
+
mapSettings?: MapSettings;
|
|
1921
|
+
}
|
|
1922
|
+
interface MapSettings {
|
|
1923
|
+
/** The address to display on the map. */
|
|
1924
|
+
address?: string | null;
|
|
1925
|
+
/** Sets whether the map is draggable. */
|
|
1926
|
+
draggable?: boolean | null;
|
|
1927
|
+
/** Sets whether the location marker is visible. */
|
|
1928
|
+
marker?: boolean | null;
|
|
1929
|
+
/** Sets whether street view control is enabled. */
|
|
1930
|
+
streetViewControl?: boolean | null;
|
|
1931
|
+
/** Sets whether zoom control is enabled. */
|
|
1932
|
+
zoomControl?: boolean | null;
|
|
1933
|
+
/** Location latitude. */
|
|
1934
|
+
lat?: number | null;
|
|
1935
|
+
/** Location longitude. */
|
|
1936
|
+
lng?: number | null;
|
|
1937
|
+
/** Location name. */
|
|
1938
|
+
locationName?: string | null;
|
|
1939
|
+
/** Sets whether view mode control is enabled. */
|
|
1940
|
+
viewModeControl?: boolean | null;
|
|
1941
|
+
/** Initial zoom value. */
|
|
1942
|
+
initialZoom?: number | null;
|
|
1943
|
+
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1944
|
+
mapType?: MapTypeWithLiterals;
|
|
1945
|
+
}
|
|
1946
|
+
declare enum MapType {
|
|
1947
|
+
/** Roadmap map type */
|
|
1948
|
+
ROADMAP = "ROADMAP",
|
|
1949
|
+
/** Satellite map type */
|
|
1950
|
+
SATELITE = "SATELITE",
|
|
1951
|
+
/** Hybrid map type */
|
|
1952
|
+
HYBRID = "HYBRID",
|
|
1953
|
+
/** Terrain map type */
|
|
1954
|
+
TERRAIN = "TERRAIN"
|
|
1955
|
+
}
|
|
1956
|
+
/** @enumType */
|
|
1957
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1958
|
+
interface ParagraphData {
|
|
1959
|
+
/** Styling for the paragraph text. */
|
|
1960
|
+
textStyle?: TextStyle;
|
|
1961
|
+
/** Indentation level from 1-4. */
|
|
1962
|
+
indentation?: number | null;
|
|
1963
|
+
/** Paragraph level */
|
|
1964
|
+
level?: number | null;
|
|
1965
|
+
}
|
|
1966
|
+
interface PollData {
|
|
1967
|
+
/** Styling for the poll's container. */
|
|
1968
|
+
containerData?: PluginContainerData;
|
|
1969
|
+
/** Poll data. */
|
|
1970
|
+
poll?: Poll;
|
|
1971
|
+
/** Layout settings for the poll and voting options. */
|
|
1972
|
+
layout?: PollDataLayout;
|
|
1973
|
+
/** Styling for the poll and voting options. */
|
|
1974
|
+
design?: Design;
|
|
1975
|
+
}
|
|
1976
|
+
declare enum ViewRole {
|
|
1977
|
+
/** Only Poll creator can view the results */
|
|
1978
|
+
CREATOR = "CREATOR",
|
|
1979
|
+
/** Anyone who voted can see the results */
|
|
1980
|
+
VOTERS = "VOTERS",
|
|
1981
|
+
/** Anyone can see the results, even if one didn't vote */
|
|
1982
|
+
EVERYONE = "EVERYONE"
|
|
1983
|
+
}
|
|
1984
|
+
/** @enumType */
|
|
1985
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1986
|
+
declare enum VoteRole {
|
|
1987
|
+
/** Logged in member */
|
|
1988
|
+
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1989
|
+
/** Anyone */
|
|
1990
|
+
ALL = "ALL"
|
|
1991
|
+
}
|
|
1992
|
+
/** @enumType */
|
|
1993
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1994
|
+
interface Permissions {
|
|
1995
|
+
/** Sets who can view the poll results. */
|
|
1996
|
+
view?: ViewRoleWithLiterals;
|
|
1997
|
+
/** Sets who can vote. */
|
|
1998
|
+
vote?: VoteRoleWithLiterals;
|
|
1999
|
+
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2000
|
+
allowMultipleVotes?: boolean | null;
|
|
2001
|
+
}
|
|
2002
|
+
interface Option {
|
|
2003
|
+
/** Option ID. */
|
|
2004
|
+
id?: string | null;
|
|
2005
|
+
/** Option title. */
|
|
2006
|
+
title?: string | null;
|
|
2007
|
+
/** The image displayed with the option. */
|
|
2008
|
+
image?: Media;
|
|
2009
|
+
}
|
|
2010
|
+
interface PollSettings {
|
|
2011
|
+
/** Permissions settings for voting. */
|
|
2012
|
+
permissions?: Permissions;
|
|
2013
|
+
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
2014
|
+
showVoters?: boolean | null;
|
|
2015
|
+
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2016
|
+
showVotesCount?: boolean | null;
|
|
2017
|
+
}
|
|
2018
|
+
declare enum PollLayoutType {
|
|
2019
|
+
/** List */
|
|
2020
|
+
LIST = "LIST",
|
|
2021
|
+
/** Grid */
|
|
2022
|
+
GRID = "GRID"
|
|
2023
|
+
}
|
|
2024
|
+
/** @enumType */
|
|
2025
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2026
|
+
declare enum PollLayoutDirection {
|
|
2027
|
+
/** Left-to-right */
|
|
2028
|
+
LTR = "LTR",
|
|
2029
|
+
/** Right-to-left */
|
|
2030
|
+
RTL = "RTL"
|
|
2031
|
+
}
|
|
2032
|
+
/** @enumType */
|
|
2033
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2034
|
+
interface PollLayout {
|
|
2035
|
+
/** The layout for displaying the voting options. */
|
|
2036
|
+
type?: PollLayoutTypeWithLiterals;
|
|
2037
|
+
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
2038
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
2039
|
+
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2040
|
+
enableImage?: boolean | null;
|
|
2041
|
+
}
|
|
2042
|
+
interface OptionLayout {
|
|
2043
|
+
/** Sets whether to display option images. Defaults to `false`. */
|
|
2044
|
+
enableImage?: boolean | null;
|
|
2045
|
+
}
|
|
2046
|
+
declare enum BackgroundType {
|
|
2047
|
+
/** Color background type */
|
|
2048
|
+
COLOR = "COLOR",
|
|
2049
|
+
/** Image background type */
|
|
2050
|
+
IMAGE = "IMAGE",
|
|
2051
|
+
/** Gradiant background type */
|
|
2052
|
+
GRADIENT = "GRADIENT"
|
|
2053
|
+
}
|
|
2054
|
+
/** @enumType */
|
|
2055
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2056
|
+
interface Gradient {
|
|
2057
|
+
/** The gradient angle in degrees. */
|
|
2058
|
+
angle?: number | null;
|
|
2059
|
+
/**
|
|
2060
|
+
* The start color as a hexademical value.
|
|
2061
|
+
* @format COLOR_HEX
|
|
2062
|
+
*/
|
|
2063
|
+
startColor?: string | null;
|
|
2064
|
+
/**
|
|
2065
|
+
* The end color as a hexademical value.
|
|
2066
|
+
* @format COLOR_HEX
|
|
2067
|
+
*/
|
|
2068
|
+
lastColor?: string | null;
|
|
2069
|
+
}
|
|
2070
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2071
|
+
/**
|
|
2072
|
+
* The background color as a hexademical value.
|
|
2073
|
+
* @format COLOR_HEX
|
|
2074
|
+
*/
|
|
2075
|
+
color?: string | null;
|
|
2076
|
+
/** An image to use for the background. */
|
|
2077
|
+
image?: Media;
|
|
2078
|
+
/** Details for a gradient background. */
|
|
2079
|
+
gradient?: Gradient;
|
|
2080
|
+
/** Background type. For each option, include the relevant details. */
|
|
2081
|
+
type?: BackgroundTypeWithLiterals;
|
|
2082
|
+
}
|
|
2083
|
+
/** @oneof */
|
|
2084
|
+
interface BackgroundBackgroundOneOf {
|
|
2085
|
+
/**
|
|
2086
|
+
* The background color as a hexademical value.
|
|
2087
|
+
* @format COLOR_HEX
|
|
2088
|
+
*/
|
|
2089
|
+
color?: string | null;
|
|
2090
|
+
/** An image to use for the background. */
|
|
2091
|
+
image?: Media;
|
|
2092
|
+
/** Details for a gradient background. */
|
|
2093
|
+
gradient?: Gradient;
|
|
2094
|
+
}
|
|
2095
|
+
interface PollDesign {
|
|
2096
|
+
/** Background styling. */
|
|
2097
|
+
background?: Background;
|
|
2098
|
+
/** Border radius in pixels. */
|
|
2099
|
+
borderRadius?: number | null;
|
|
2100
|
+
}
|
|
2101
|
+
interface OptionDesign {
|
|
2102
|
+
/** Border radius in pixels. */
|
|
2103
|
+
borderRadius?: number | null;
|
|
2104
|
+
}
|
|
2105
|
+
interface Poll {
|
|
2106
|
+
/** Poll ID. */
|
|
2107
|
+
id?: string | null;
|
|
2108
|
+
/** Poll title. */
|
|
2109
|
+
title?: string | null;
|
|
2110
|
+
/** Poll creator ID. */
|
|
2111
|
+
creatorId?: string | null;
|
|
2112
|
+
/** Main poll image. */
|
|
2113
|
+
image?: Media;
|
|
2114
|
+
/** Voting options. */
|
|
2115
|
+
options?: Option[];
|
|
2116
|
+
/** The poll's permissions and display settings. */
|
|
2117
|
+
settings?: PollSettings;
|
|
2118
|
+
}
|
|
2119
|
+
interface PollDataLayout {
|
|
2120
|
+
/** Poll layout settings. */
|
|
2121
|
+
poll?: PollLayout;
|
|
2122
|
+
/** Voting otpions layout settings. */
|
|
2123
|
+
options?: OptionLayout;
|
|
2124
|
+
}
|
|
2125
|
+
interface Design {
|
|
2126
|
+
/** Styling for the poll. */
|
|
2127
|
+
poll?: PollDesign;
|
|
2128
|
+
/** Styling for voting options. */
|
|
2129
|
+
options?: OptionDesign;
|
|
2130
|
+
}
|
|
2131
|
+
interface TextData {
|
|
2132
|
+
/** The text to apply decorations to. */
|
|
2133
|
+
text?: string;
|
|
2134
|
+
/** The decorations to apply. */
|
|
2135
|
+
decorations?: Decoration[];
|
|
2136
|
+
}
|
|
2137
|
+
/** Adds appearence changes to text */
|
|
2138
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2139
|
+
/** Data for an anchor link decoration. */
|
|
2140
|
+
anchorData?: AnchorData;
|
|
2141
|
+
/** Data for a color decoration. */
|
|
2142
|
+
colorData?: ColorData;
|
|
2143
|
+
/** Data for an external link decoration. */
|
|
2144
|
+
linkData?: LinkData;
|
|
2145
|
+
/** Data for a mention decoration. */
|
|
2146
|
+
mentionData?: MentionData;
|
|
2147
|
+
/** Data for a font size decoration. */
|
|
2148
|
+
fontSizeData?: FontSizeData;
|
|
2149
|
+
/** Font weight for a bold decoration. */
|
|
2150
|
+
fontWeightValue?: number | null;
|
|
2151
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
2152
|
+
italicData?: boolean | null;
|
|
2153
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
2154
|
+
underlineData?: boolean | null;
|
|
2155
|
+
/** Data for a spoiler decoration. */
|
|
2156
|
+
spoilerData?: SpoilerData;
|
|
2157
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2158
|
+
strikethroughData?: boolean | null;
|
|
2159
|
+
/** The type of decoration to apply. */
|
|
2160
|
+
type?: DecorationTypeWithLiterals;
|
|
2161
|
+
}
|
|
2162
|
+
/** @oneof */
|
|
2163
|
+
interface DecorationDataOneOf {
|
|
2164
|
+
/** Data for an anchor link decoration. */
|
|
2165
|
+
anchorData?: AnchorData;
|
|
2166
|
+
/** Data for a color decoration. */
|
|
2167
|
+
colorData?: ColorData;
|
|
2168
|
+
/** Data for an external link decoration. */
|
|
2169
|
+
linkData?: LinkData;
|
|
2170
|
+
/** Data for a mention decoration. */
|
|
2171
|
+
mentionData?: MentionData;
|
|
2172
|
+
/** Data for a font size decoration. */
|
|
2173
|
+
fontSizeData?: FontSizeData;
|
|
2174
|
+
/** Font weight for a bold decoration. */
|
|
2175
|
+
fontWeightValue?: number | null;
|
|
2176
|
+
/** Data for an italic decoration. Defaults to `true`. */
|
|
2177
|
+
italicData?: boolean | null;
|
|
2178
|
+
/** Data for an underline decoration. Defaults to `true`. */
|
|
2179
|
+
underlineData?: boolean | null;
|
|
2180
|
+
/** Data for a spoiler decoration. */
|
|
2181
|
+
spoilerData?: SpoilerData;
|
|
2182
|
+
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2183
|
+
strikethroughData?: boolean | null;
|
|
2184
|
+
}
|
|
2185
|
+
declare enum DecorationType {
|
|
2186
|
+
BOLD = "BOLD",
|
|
2187
|
+
ITALIC = "ITALIC",
|
|
2188
|
+
UNDERLINE = "UNDERLINE",
|
|
2189
|
+
SPOILER = "SPOILER",
|
|
2190
|
+
ANCHOR = "ANCHOR",
|
|
2191
|
+
MENTION = "MENTION",
|
|
2192
|
+
LINK = "LINK",
|
|
2193
|
+
COLOR = "COLOR",
|
|
2194
|
+
FONT_SIZE = "FONT_SIZE",
|
|
2195
|
+
EXTERNAL = "EXTERNAL",
|
|
2196
|
+
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2197
|
+
}
|
|
2198
|
+
/** @enumType */
|
|
2199
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2200
|
+
interface AnchorData {
|
|
2201
|
+
/** The target node's ID. */
|
|
2202
|
+
anchor?: string;
|
|
2203
|
+
}
|
|
2204
|
+
interface ColorData {
|
|
2205
|
+
/** The text's background color as a hexadecimal value. */
|
|
2206
|
+
background?: string | null;
|
|
2207
|
+
/** The text's foreground color as a hexadecimal value. */
|
|
2208
|
+
foreground?: string | null;
|
|
2209
|
+
}
|
|
2210
|
+
interface LinkData {
|
|
2211
|
+
/** Link details. */
|
|
2212
|
+
link?: Link;
|
|
2213
|
+
}
|
|
2214
|
+
interface MentionData {
|
|
2215
|
+
/** The mentioned user's name. */
|
|
2216
|
+
name?: string;
|
|
2217
|
+
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
2218
|
+
slug?: string;
|
|
2219
|
+
/** Mentioned user's ID. */
|
|
2220
|
+
id?: string | null;
|
|
2221
|
+
}
|
|
2222
|
+
interface FontSizeData {
|
|
2223
|
+
/** The units used for the font size. */
|
|
2224
|
+
unit?: FontTypeWithLiterals;
|
|
2225
|
+
/** Font size value. */
|
|
2226
|
+
value?: number | null;
|
|
2227
|
+
}
|
|
2228
|
+
declare enum FontType {
|
|
2229
|
+
PX = "PX",
|
|
2230
|
+
EM = "EM"
|
|
2231
|
+
}
|
|
2232
|
+
/** @enumType */
|
|
2233
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2234
|
+
interface SpoilerData {
|
|
2235
|
+
/** Spoiler ID. */
|
|
2236
|
+
id?: string | null;
|
|
2237
|
+
}
|
|
2238
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2239
|
+
/** Data for embedded Wix Bookings content. */
|
|
2240
|
+
bookingData?: BookingData;
|
|
2241
|
+
/** Data for embedded Wix Events content. */
|
|
2242
|
+
eventData?: EventData;
|
|
2243
|
+
/** The type of Wix App content being embedded. */
|
|
2244
|
+
type?: AppTypeWithLiterals;
|
|
2245
|
+
/** The ID of the embedded content. */
|
|
2246
|
+
itemId?: string | null;
|
|
2247
|
+
/** The name of the embedded content. */
|
|
2248
|
+
name?: string | null;
|
|
2249
|
+
/**
|
|
2250
|
+
* Deprecated: Use `image` instead.
|
|
2251
|
+
* @deprecated
|
|
2252
|
+
*/
|
|
2253
|
+
imageSrc?: string | null;
|
|
2254
|
+
/** The URL for the embedded content. */
|
|
2255
|
+
url?: string | null;
|
|
2256
|
+
/** An image for the embedded content. */
|
|
2257
|
+
image?: Media;
|
|
2258
|
+
}
|
|
2259
|
+
/** @oneof */
|
|
2260
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2261
|
+
/** Data for embedded Wix Bookings content. */
|
|
2262
|
+
bookingData?: BookingData;
|
|
2263
|
+
/** Data for embedded Wix Events content. */
|
|
2264
|
+
eventData?: EventData;
|
|
2265
|
+
}
|
|
2266
|
+
declare enum AppType {
|
|
2267
|
+
PRODUCT = "PRODUCT",
|
|
2268
|
+
EVENT = "EVENT",
|
|
2269
|
+
BOOKING = "BOOKING"
|
|
2270
|
+
}
|
|
2271
|
+
/** @enumType */
|
|
2272
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2273
|
+
interface BookingData {
|
|
2274
|
+
/** Booking duration in minutes. */
|
|
2275
|
+
durations?: string | null;
|
|
2276
|
+
}
|
|
2277
|
+
interface EventData {
|
|
2278
|
+
/** Event schedule. */
|
|
2279
|
+
scheduling?: string | null;
|
|
2280
|
+
/** Event location. */
|
|
2281
|
+
location?: string | null;
|
|
2282
|
+
}
|
|
2283
|
+
interface VideoData {
|
|
2284
|
+
/** Styling for the video's container. */
|
|
2285
|
+
containerData?: PluginContainerData;
|
|
2286
|
+
/** Video details. */
|
|
2287
|
+
video?: Media;
|
|
2288
|
+
/** Video thumbnail details. */
|
|
2289
|
+
thumbnail?: Media;
|
|
2290
|
+
/** Sets whether the video's download button is disabled. Defaults to `false`. */
|
|
2291
|
+
disableDownload?: boolean | null;
|
|
2292
|
+
/** Video title. */
|
|
2293
|
+
title?: string | null;
|
|
2294
|
+
/** Video options. */
|
|
2295
|
+
options?: PlaybackOptions;
|
|
2296
|
+
}
|
|
2297
|
+
interface PlaybackOptions {
|
|
2298
|
+
/** Sets whether the media will automatically start playing. */
|
|
2299
|
+
autoPlay?: boolean | null;
|
|
2300
|
+
/** Sets whether media's will be looped. */
|
|
2301
|
+
playInLoop?: boolean | null;
|
|
2302
|
+
/** Sets whether media's controls will be shown. */
|
|
2303
|
+
showControls?: boolean | null;
|
|
2304
|
+
}
|
|
2305
|
+
interface EmbedData {
|
|
2306
|
+
/** Styling for the oEmbed node's container. */
|
|
2307
|
+
containerData?: PluginContainerData;
|
|
2308
|
+
/** An [oEmbed](https://www.oembed.com) object. */
|
|
2309
|
+
oembed?: Oembed;
|
|
2310
|
+
/** Origin asset source. */
|
|
2311
|
+
src?: string | null;
|
|
2312
|
+
}
|
|
2313
|
+
interface Oembed {
|
|
2314
|
+
/** The resource type. */
|
|
2315
|
+
type?: string | null;
|
|
2316
|
+
/** The width of the resource specified in the `url` property in pixels. */
|
|
2317
|
+
width?: number | null;
|
|
2318
|
+
/** The height of the resource specified in the `url` property in pixels. */
|
|
2319
|
+
height?: number | null;
|
|
2320
|
+
/** Resource title. */
|
|
2321
|
+
title?: string | null;
|
|
2322
|
+
/** The source URL for the resource. */
|
|
2323
|
+
url?: string | null;
|
|
2324
|
+
/** HTML for embedding a video player. The HTML should have no padding or margins. */
|
|
2325
|
+
html?: string | null;
|
|
2326
|
+
/** The name of the author or owner of the resource. */
|
|
2327
|
+
authorName?: string | null;
|
|
2328
|
+
/** The URL for the author or owner of the resource. */
|
|
2329
|
+
authorUrl?: string | null;
|
|
2330
|
+
/** The name of the resource provider. */
|
|
2331
|
+
providerName?: string | null;
|
|
2332
|
+
/** The URL for the resource provider. */
|
|
2333
|
+
providerUrl?: string | null;
|
|
2334
|
+
/** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
|
|
2335
|
+
thumbnailUrl?: string | null;
|
|
2336
|
+
/** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
|
|
2337
|
+
thumbnailWidth?: string | null;
|
|
2338
|
+
/** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
|
|
2339
|
+
thumbnailHeight?: string | null;
|
|
2340
|
+
/** The URL for an embedded viedo. */
|
|
2341
|
+
videoUrl?: string | null;
|
|
2342
|
+
/** The oEmbed version number. This value must be `1.0`. */
|
|
2343
|
+
version?: string | null;
|
|
2344
|
+
}
|
|
2345
|
+
interface CollapsibleListData {
|
|
2346
|
+
/** Styling for the collapsible list's container. */
|
|
2347
|
+
containerData?: PluginContainerData;
|
|
2348
|
+
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
2349
|
+
expandOnlyOne?: boolean | null;
|
|
2350
|
+
/** Sets which items are expanded when the page loads. */
|
|
2351
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
2352
|
+
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
2353
|
+
direction?: DirectionWithLiterals;
|
|
2354
|
+
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
2355
|
+
isQapageData?: boolean | null;
|
|
2356
|
+
}
|
|
2357
|
+
declare enum InitialExpandedItems {
|
|
2358
|
+
/** First item will be expended initally */
|
|
2359
|
+
FIRST = "FIRST",
|
|
2360
|
+
/** All items will expended initally */
|
|
2361
|
+
ALL = "ALL",
|
|
2362
|
+
/** All items collapsed initally */
|
|
2363
|
+
NONE = "NONE"
|
|
2364
|
+
}
|
|
2365
|
+
/** @enumType */
|
|
2366
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
2367
|
+
declare enum Direction {
|
|
2368
|
+
/** Left-to-right */
|
|
2369
|
+
LTR = "LTR",
|
|
2370
|
+
/** Right-to-left */
|
|
2371
|
+
RTL = "RTL"
|
|
2372
|
+
}
|
|
2373
|
+
/** @enumType */
|
|
2374
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
2375
|
+
interface TableData {
|
|
2376
|
+
/** Styling for the table's container. */
|
|
2377
|
+
containerData?: PluginContainerData;
|
|
2378
|
+
/** The table's dimensions. */
|
|
2379
|
+
dimensions?: Dimensions;
|
|
2380
|
+
/**
|
|
2381
|
+
* Deprecated: Use `rowHeader` and `columnHeader` instead.
|
|
2382
|
+
* @deprecated
|
|
2383
|
+
*/
|
|
2384
|
+
header?: boolean | null;
|
|
2385
|
+
/** Sets whether the table's first row is a header. Defaults to `false`. */
|
|
2386
|
+
rowHeader?: boolean | null;
|
|
2387
|
+
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
2388
|
+
columnHeader?: boolean | null;
|
|
2389
|
+
}
|
|
2390
|
+
interface Dimensions {
|
|
2391
|
+
/** An array representing relative width of each column in relation to the other columns. */
|
|
2392
|
+
colsWidthRatio?: number[];
|
|
2393
|
+
/** An array representing the height of each row in pixels. */
|
|
2394
|
+
rowsHeight?: number[];
|
|
2395
|
+
/** An array representing the minimum width of each column in pixels. */
|
|
2396
|
+
colsMinWidth?: number[];
|
|
2397
|
+
}
|
|
2398
|
+
interface TableCellData {
|
|
2399
|
+
/** Styling for the cell's background color and text alignment. */
|
|
2400
|
+
cellStyle?: CellStyle;
|
|
2401
|
+
/** The cell's border colors. */
|
|
2402
|
+
borderColors?: BorderColors;
|
|
2403
|
+
}
|
|
2404
|
+
declare enum VerticalAlignment {
|
|
2405
|
+
/** Top alignment */
|
|
2406
|
+
TOP = "TOP",
|
|
2407
|
+
/** Middle alignment */
|
|
2408
|
+
MIDDLE = "MIDDLE",
|
|
2409
|
+
/** Bottom alignment */
|
|
2410
|
+
BOTTOM = "BOTTOM"
|
|
2411
|
+
}
|
|
2412
|
+
/** @enumType */
|
|
2413
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
2414
|
+
interface CellStyle {
|
|
2415
|
+
/** Vertical alignment for the cell's text. */
|
|
2416
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
2417
|
+
/**
|
|
2418
|
+
* Cell background color as a hexadecimal value.
|
|
2419
|
+
* @format COLOR_HEX
|
|
2420
|
+
*/
|
|
2421
|
+
backgroundColor?: string | null;
|
|
2422
|
+
}
|
|
2423
|
+
interface BorderColors {
|
|
2424
|
+
/**
|
|
2425
|
+
* Left border color as a hexadecimal value.
|
|
2426
|
+
* @format COLOR_HEX
|
|
2427
|
+
*/
|
|
2428
|
+
left?: string | null;
|
|
2429
|
+
/**
|
|
2430
|
+
* Right border color as a hexadecimal value.
|
|
2431
|
+
* @format COLOR_HEX
|
|
2432
|
+
*/
|
|
2433
|
+
right?: string | null;
|
|
2434
|
+
/**
|
|
2435
|
+
* Top border color as a hexadecimal value.
|
|
2436
|
+
* @format COLOR_HEX
|
|
2437
|
+
*/
|
|
2438
|
+
top?: string | null;
|
|
2439
|
+
/**
|
|
2440
|
+
* Bottom border color as a hexadecimal value.
|
|
2441
|
+
* @format COLOR_HEX
|
|
2442
|
+
*/
|
|
2443
|
+
bottom?: string | null;
|
|
2444
|
+
}
|
|
2445
|
+
interface AudioData {
|
|
2446
|
+
/** Styling for the audio node's container. */
|
|
2447
|
+
containerData?: PluginContainerData;
|
|
2448
|
+
/** Audio file details. */
|
|
2449
|
+
audio?: Media;
|
|
2450
|
+
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
|
|
2451
|
+
disableDownload?: boolean | null;
|
|
2452
|
+
/** Cover image. */
|
|
2453
|
+
coverImage?: Media;
|
|
2454
|
+
/** Track name. */
|
|
2455
|
+
name?: string | null;
|
|
2456
|
+
/** Author name. */
|
|
2457
|
+
authorName?: string | null;
|
|
2458
|
+
/** An HTML version of the audio node. */
|
|
2459
|
+
html?: string | null;
|
|
2460
|
+
}
|
|
2461
|
+
interface OrderedListData {
|
|
2462
|
+
/** Indentation level from 0-4. */
|
|
2463
|
+
indentation?: number;
|
|
2464
|
+
/** Offset level from 0-4. */
|
|
2465
|
+
offset?: number | null;
|
|
2466
|
+
/** List start number. */
|
|
2467
|
+
start?: number | null;
|
|
2468
|
+
}
|
|
2469
|
+
interface BulletedListData {
|
|
2470
|
+
/** Indentation level from 0-4. */
|
|
2471
|
+
indentation?: number;
|
|
2472
|
+
/** Offset level from 0-4. */
|
|
2473
|
+
offset?: number | null;
|
|
2474
|
+
}
|
|
2475
|
+
interface BlockquoteData {
|
|
2476
|
+
/** Indentation level from 1-4. */
|
|
2477
|
+
indentation?: number;
|
|
2478
|
+
}
|
|
2479
|
+
interface CaptionData {
|
|
2480
|
+
textStyle?: TextStyle;
|
|
2481
|
+
}
|
|
2482
|
+
interface LayoutCellData {
|
|
2483
|
+
/** Size of the cell in 12 columns grid. */
|
|
2484
|
+
colSpan?: number | null;
|
|
2485
|
+
}
|
|
2486
|
+
interface Metadata {
|
|
2487
|
+
/** Schema version. */
|
|
2488
|
+
version?: number;
|
|
2489
|
+
/**
|
|
2490
|
+
* When the object was created.
|
|
2491
|
+
* @readonly
|
|
2492
|
+
* @deprecated
|
|
2493
|
+
*/
|
|
2494
|
+
createdTimestamp?: Date | null;
|
|
2495
|
+
/**
|
|
2496
|
+
* When the object was most recently updated.
|
|
2497
|
+
* @deprecated
|
|
2498
|
+
*/
|
|
2499
|
+
updatedTimestamp?: Date | null;
|
|
2500
|
+
/** Object ID. */
|
|
2501
|
+
id?: string | null;
|
|
2502
|
+
}
|
|
2503
|
+
interface DocumentStyle {
|
|
2504
|
+
/** Styling for H1 nodes. */
|
|
2505
|
+
headerOne?: TextNodeStyle;
|
|
2506
|
+
/** Styling for H2 nodes. */
|
|
2507
|
+
headerTwo?: TextNodeStyle;
|
|
2508
|
+
/** Styling for H3 nodes. */
|
|
2509
|
+
headerThree?: TextNodeStyle;
|
|
2510
|
+
/** Styling for H4 nodes. */
|
|
2511
|
+
headerFour?: TextNodeStyle;
|
|
2512
|
+
/** Styling for H5 nodes. */
|
|
2513
|
+
headerFive?: TextNodeStyle;
|
|
2514
|
+
/** Styling for H6 nodes. */
|
|
2515
|
+
headerSix?: TextNodeStyle;
|
|
2516
|
+
/** Styling for paragraph nodes. */
|
|
2517
|
+
paragraph?: TextNodeStyle;
|
|
2518
|
+
/** Styling for block quote nodes. */
|
|
2519
|
+
blockquote?: TextNodeStyle;
|
|
2520
|
+
/** Styling for code block nodes. */
|
|
2521
|
+
codeBlock?: TextNodeStyle;
|
|
2522
|
+
}
|
|
2523
|
+
interface TextNodeStyle {
|
|
2524
|
+
/** The decorations to apply to the node. */
|
|
2525
|
+
decorations?: Decoration[];
|
|
2526
|
+
/** Padding and background color for the node. */
|
|
2527
|
+
nodeStyle?: NodeStyle;
|
|
2528
|
+
/** Line height for text in the node. */
|
|
2529
|
+
lineHeight?: string | null;
|
|
2530
|
+
}
|
|
2531
|
+
interface CreateEventRequest {
|
|
2532
|
+
/** Event data. */
|
|
2533
|
+
event: V3Event;
|
|
2534
|
+
/** Whether to create the event as a draft. */
|
|
2535
|
+
draft?: boolean;
|
|
2536
|
+
/**
|
|
2537
|
+
* Predefined sets of fields to return.
|
|
2538
|
+
* @maxSize 20
|
|
2539
|
+
*/
|
|
2540
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2541
|
+
}
|
|
2542
|
+
declare enum RequestedFields {
|
|
2543
|
+
/** Unknown requested field. */
|
|
2544
|
+
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2545
|
+
/** Returns `shortDescription`, `mainImage` and `calendarUrls`. */
|
|
2546
|
+
DETAILS = "DETAILS",
|
|
2547
|
+
/** Returns `description`. */
|
|
2548
|
+
TEXTS = "TEXTS",
|
|
2549
|
+
/** Returns `registration`. */
|
|
2550
|
+
REGISTRATION = "REGISTRATION",
|
|
2551
|
+
/** Returns `eventPageUrl`. */
|
|
2552
|
+
URLS = "URLS",
|
|
2553
|
+
/** Returns `form`. */
|
|
2554
|
+
FORM = "FORM",
|
|
2555
|
+
/** Returns `summaries`. */
|
|
2556
|
+
DASHBOARD = "DASHBOARD",
|
|
2557
|
+
/** Returns `feed`. */
|
|
2558
|
+
FEED = "FEED",
|
|
2559
|
+
/** Returns `onlineConferencing.session`. */
|
|
2560
|
+
ONLINE_CONFERENCING_SESSION = "ONLINE_CONFERENCING_SESSION",
|
|
2561
|
+
/** Returns `seoSettings`. */
|
|
2562
|
+
SEO_SETTINGS = "SEO_SETTINGS",
|
|
2563
|
+
/** Returns `agendaSettings`. */
|
|
2564
|
+
AGENDA = "AGENDA",
|
|
2565
|
+
/** Returns `categories`. */
|
|
2566
|
+
CATEGORIES = "CATEGORIES"
|
|
2567
|
+
}
|
|
2568
|
+
/** @enumType */
|
|
2569
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DETAILS' | 'TEXTS' | 'REGISTRATION' | 'URLS' | 'FORM' | 'DASHBOARD' | 'FEED' | 'ONLINE_CONFERENCING_SESSION' | 'SEO_SETTINGS' | 'AGENDA' | 'CATEGORIES';
|
|
2570
|
+
interface CreateEventResponse {
|
|
2571
|
+
/** Created event. */
|
|
2572
|
+
event?: V3Event;
|
|
2573
|
+
}
|
|
2574
|
+
interface CloneEventRequest {
|
|
2575
|
+
/**
|
|
2576
|
+
* Event ID.
|
|
2577
|
+
* @format GUID
|
|
2578
|
+
*/
|
|
2579
|
+
eventId: string;
|
|
2580
|
+
/** Field values to be changed when cloning the event. */
|
|
2581
|
+
event?: V3Event;
|
|
2582
|
+
/** Whether to clone the event as a draft. */
|
|
2583
|
+
draft?: boolean;
|
|
2584
|
+
/**
|
|
2585
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2586
|
+
* @maxSize 20
|
|
2587
|
+
*/
|
|
2588
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2589
|
+
}
|
|
2590
|
+
interface CloneEventResponse {
|
|
2591
|
+
/** Cloned event. */
|
|
2592
|
+
event?: V3Event;
|
|
2593
|
+
}
|
|
2594
|
+
interface UpdateEventRequest {
|
|
2595
|
+
/** Field values to be changed. */
|
|
2596
|
+
event?: V3Event;
|
|
2597
|
+
/**
|
|
2598
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2599
|
+
* @maxSize 20
|
|
2600
|
+
*/
|
|
2601
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2602
|
+
}
|
|
2603
|
+
interface UpdateEventResponse {
|
|
2604
|
+
/** Updated event. */
|
|
2605
|
+
event?: V3Event;
|
|
2606
|
+
}
|
|
2607
|
+
interface PublishDraftEventRequest {
|
|
2608
|
+
/**
|
|
2609
|
+
* Event ID.
|
|
2610
|
+
* @format GUID
|
|
2611
|
+
*/
|
|
2612
|
+
eventId: string;
|
|
2613
|
+
/**
|
|
2614
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2615
|
+
* @maxSize 20
|
|
2616
|
+
*/
|
|
2617
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2618
|
+
}
|
|
2619
|
+
interface PublishDraftEventResponse {
|
|
2620
|
+
/** Published event. */
|
|
2621
|
+
event?: V3Event;
|
|
2622
|
+
}
|
|
2623
|
+
interface CancelEventRequest {
|
|
2624
|
+
/**
|
|
2625
|
+
* Event ID.
|
|
2626
|
+
* @format GUID
|
|
2627
|
+
*/
|
|
2628
|
+
eventId: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
|
|
2631
|
+
* @maxSize 20
|
|
2632
|
+
*/
|
|
2633
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2634
|
+
}
|
|
2635
|
+
interface CancelEventResponse {
|
|
2636
|
+
/** Canceled event. */
|
|
2637
|
+
event?: V3Event;
|
|
2638
|
+
}
|
|
2639
|
+
interface BulkCancelEventsByFilterRequest {
|
|
2640
|
+
/** Filter. See [supported fields and operators](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/filter-and-sort). */
|
|
2641
|
+
filter?: CommonQueryV2;
|
|
2642
|
+
}
|
|
2643
|
+
interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
|
|
2644
|
+
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2645
|
+
paging?: CommonPaging;
|
|
2646
|
+
/**
|
|
2647
|
+
* Filter object in the following format:
|
|
2648
|
+
* `"filter" : {
|
|
2649
|
+
* "fieldName1": "value1",
|
|
2650
|
+
* "fieldName2":{"$operator":"value2"}
|
|
2651
|
+
* }`
|
|
2652
|
+
*/
|
|
2653
|
+
filter?: Record<string, any> | null;
|
|
2654
|
+
/**
|
|
2655
|
+
* Sort object in the following format:
|
|
2656
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2657
|
+
* @maxSize 20
|
|
2658
|
+
*/
|
|
2659
|
+
sort?: CommonSorting[];
|
|
2660
|
+
}
|
|
2661
|
+
/** @oneof */
|
|
2662
|
+
interface CommonQueryV2PagingMethodOneOf {
|
|
2663
|
+
/** Paging options. Can't be used together with `cursorPaging`. */
|
|
2664
|
+
paging?: CommonPaging;
|
|
2665
|
+
}
|
|
2666
|
+
interface CommonSorting {
|
|
2667
|
+
/**
|
|
2668
|
+
* Name of the field to sort by.
|
|
2669
|
+
* @maxLength 100
|
|
2670
|
+
*/
|
|
2671
|
+
fieldName?: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* Sort order.
|
|
2674
|
+
* Use `ASC` for ascending order or `DESC` for descending order.
|
|
2675
|
+
*
|
|
2676
|
+
* Default: `ASC`.
|
|
2677
|
+
*/
|
|
2678
|
+
order?: CommonSortOrderWithLiterals;
|
|
2679
|
+
}
|
|
2680
|
+
declare enum CommonSortOrder {
|
|
2681
|
+
ASC = "ASC",
|
|
2682
|
+
DESC = "DESC"
|
|
2683
|
+
}
|
|
2684
|
+
/** @enumType */
|
|
2685
|
+
type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
2686
|
+
interface CommonPaging {
|
|
2687
|
+
/**
|
|
2688
|
+
* Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
|
|
2689
|
+
* @max 1000
|
|
2690
|
+
*/
|
|
2691
|
+
limit?: number | null;
|
|
2692
|
+
/** Number of items to skip in the current sort order. */
|
|
2693
|
+
offset?: number | null;
|
|
2694
|
+
}
|
|
2695
|
+
interface BulkCancelEventsByFilterResponse {
|
|
2696
|
+
}
|
|
2697
|
+
interface DeleteEventRequest {
|
|
2698
|
+
/**
|
|
2699
|
+
* Event ID.
|
|
2700
|
+
* @format GUID
|
|
2701
|
+
*/
|
|
2702
|
+
eventId: string;
|
|
2703
|
+
}
|
|
2704
|
+
interface DeleteEventResponse {
|
|
2705
|
+
/**
|
|
2706
|
+
* Deleted event ID.
|
|
2707
|
+
* @format GUID
|
|
2708
|
+
*/
|
|
2709
|
+
eventId?: string;
|
|
2710
|
+
}
|
|
2711
|
+
interface BulkDeleteEventsByFilterRequest {
|
|
2712
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2713
|
+
filter?: CommonQueryV2;
|
|
2714
|
+
}
|
|
2715
|
+
interface BulkDeleteEventsByFilterResponse {
|
|
2716
|
+
}
|
|
2717
|
+
interface QueryEventsRequest {
|
|
2718
|
+
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
2719
|
+
query?: CommonQueryV2;
|
|
2720
|
+
/**
|
|
2721
|
+
* Predefined sets of fields to return.
|
|
2722
|
+
* @maxSize 20
|
|
2723
|
+
*/
|
|
2724
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2725
|
+
/**
|
|
2726
|
+
* Whether draft events should be returned in the response. <br>
|
|
2727
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
2728
|
+
*/
|
|
2729
|
+
includeDrafts?: boolean;
|
|
2730
|
+
}
|
|
2731
|
+
interface QueryEventsResponse {
|
|
2732
|
+
/** Metadata for the paginated results. */
|
|
2733
|
+
pagingMetadata?: CommonPagingMetadataV2;
|
|
2734
|
+
/** List of events. */
|
|
2735
|
+
events?: V3Event[];
|
|
2736
|
+
}
|
|
2737
|
+
interface CommonPagingMetadataV2 {
|
|
2738
|
+
/** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
|
|
2739
|
+
count?: number | null;
|
|
2740
|
+
/** Requested offset. */
|
|
2741
|
+
offset?: number | null;
|
|
2742
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
2743
|
+
total?: number | null;
|
|
2744
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
2745
|
+
tooManyToCount?: boolean | null;
|
|
2746
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
2747
|
+
cursors?: CommonCursors;
|
|
2748
|
+
}
|
|
2749
|
+
interface CommonCursors {
|
|
2750
|
+
/** Cursor pointing to the next page in the list of results. */
|
|
2751
|
+
next?: string | null;
|
|
2752
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
2753
|
+
prev?: string | null;
|
|
2754
|
+
}
|
|
2755
|
+
interface CountEventsByStatusRequest {
|
|
2756
|
+
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
2757
|
+
filter?: Record<string, any> | null;
|
|
2758
|
+
/**
|
|
2759
|
+
* Parameters to count events by.
|
|
2760
|
+
* @maxLength 100
|
|
2761
|
+
* @maxSize 20
|
|
2762
|
+
*/
|
|
2763
|
+
facet?: string[];
|
|
2764
|
+
/**
|
|
2765
|
+
* Whether draft events should be returned in the response. <br>
|
|
2766
|
+
* **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.
|
|
2767
|
+
*/
|
|
2768
|
+
includeDrafts?: boolean;
|
|
2769
|
+
}
|
|
2770
|
+
interface CountEventsByStatusResponse {
|
|
2771
|
+
/** Metadata for the paginated results. */
|
|
2772
|
+
pagingMetadata?: CommonPagingMetadataV2;
|
|
2773
|
+
/** Filter facets. */
|
|
2774
|
+
facets?: Record<string, FacetCounts>;
|
|
2775
|
+
}
|
|
2776
|
+
interface FacetCounts {
|
|
2777
|
+
/** Facet counts aggregated per value */
|
|
2778
|
+
counts?: Record<string, number>;
|
|
2779
|
+
}
|
|
2780
|
+
interface GetEventRequest {
|
|
2781
|
+
/**
|
|
2782
|
+
* Event ID.
|
|
2783
|
+
* @format GUID
|
|
2784
|
+
*/
|
|
2785
|
+
eventId: string | null;
|
|
2786
|
+
/**
|
|
2787
|
+
* Predefined sets of fields to return.
|
|
2788
|
+
* @maxSize 20
|
|
2789
|
+
*/
|
|
2790
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2791
|
+
}
|
|
2792
|
+
interface GetEventResponse {
|
|
2793
|
+
/** Event. */
|
|
2794
|
+
event?: V3Event;
|
|
2795
|
+
}
|
|
2796
|
+
interface GetEventBySlugRequest {
|
|
2797
|
+
/**
|
|
2798
|
+
* URL slug.
|
|
2799
|
+
* @minLength 1
|
|
2800
|
+
* @maxLength 130
|
|
2801
|
+
*/
|
|
2802
|
+
slug: string | null;
|
|
2803
|
+
/** @maxSize 20 */
|
|
2804
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2805
|
+
}
|
|
2806
|
+
interface GetEventBySlugResponse {
|
|
2807
|
+
/** Event. */
|
|
2808
|
+
event?: V3Event;
|
|
2809
|
+
}
|
|
2810
|
+
|
|
2811
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
2812
|
+
getUrl: (context: any) => string;
|
|
2813
|
+
httpMethod: K;
|
|
2814
|
+
path: string;
|
|
2815
|
+
pathParams: M;
|
|
2816
|
+
__requestType: T;
|
|
2817
|
+
__originalRequestType: S;
|
|
2818
|
+
__responseType: Q;
|
|
2819
|
+
__originalResponseType: R;
|
|
2820
|
+
};
|
|
2821
|
+
declare function createEvent(): __PublicMethodMetaInfo<'POST', {}, CreateEventRequest$1, CreateEventRequest, CreateEventResponse$1, CreateEventResponse>;
|
|
2822
|
+
declare function cloneEvent(): __PublicMethodMetaInfo<'POST', {
|
|
2823
|
+
eventId: string;
|
|
2824
|
+
}, CloneEventRequest$1, CloneEventRequest, CloneEventResponse$1, CloneEventResponse>;
|
|
2825
|
+
declare function updateEvent(): __PublicMethodMetaInfo<'PATCH', {
|
|
2826
|
+
eventId: string;
|
|
2827
|
+
}, UpdateEventRequest$1, UpdateEventRequest, UpdateEventResponse$1, UpdateEventResponse>;
|
|
2828
|
+
declare function publishDraftEvent(): __PublicMethodMetaInfo<'POST', {
|
|
2829
|
+
eventId: string;
|
|
2830
|
+
}, PublishDraftEventRequest$1, PublishDraftEventRequest, PublishDraftEventResponse$1, PublishDraftEventResponse>;
|
|
2831
|
+
declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {
|
|
2832
|
+
eventId: string;
|
|
2833
|
+
}, CancelEventRequest$1, CancelEventRequest, CancelEventResponse$1, CancelEventResponse>;
|
|
2834
|
+
declare function bulkCancelEventsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventsByFilterRequest$1, BulkCancelEventsByFilterRequest, BulkCancelEventsByFilterResponse$1, BulkCancelEventsByFilterResponse>;
|
|
2835
|
+
declare function deleteEvent(): __PublicMethodMetaInfo<'DELETE', {
|
|
2836
|
+
eventId: string;
|
|
2837
|
+
}, DeleteEventRequest$1, DeleteEventRequest, DeleteEventResponse$1, DeleteEventResponse>;
|
|
2838
|
+
declare function bulkDeleteEventsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteEventsByFilterRequest$1, BulkDeleteEventsByFilterRequest, BulkDeleteEventsByFilterResponse$1, BulkDeleteEventsByFilterResponse>;
|
|
2839
|
+
declare function queryEvents(): __PublicMethodMetaInfo<'POST', {}, QueryEventsRequest$1, QueryEventsRequest, QueryEventsResponse$1, QueryEventsResponse>;
|
|
2840
|
+
declare function countEventsByStatus(): __PublicMethodMetaInfo<'POST', {}, CountEventsByStatusRequest$1, CountEventsByStatusRequest, CountEventsByStatusResponse$1, CountEventsByStatusResponse>;
|
|
2841
|
+
declare function getEvent(): __PublicMethodMetaInfo<'GET', {
|
|
2842
|
+
eventId: string;
|
|
2843
|
+
}, GetEventRequest$1, GetEventRequest, GetEventResponse$1, GetEventResponse>;
|
|
2844
|
+
declare function getEventBySlug(): __PublicMethodMetaInfo<'GET', {
|
|
2845
|
+
slug: string;
|
|
2846
|
+
}, GetEventBySlugRequest$1, GetEventBySlugRequest, GetEventBySlugResponse$1, GetEventBySlugResponse>;
|
|
2847
|
+
|
|
2848
|
+
export { type __PublicMethodMetaInfo, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, publishDraftEvent, queryEvents, updateEvent };
|