@wix/auto_sdk_events_notifications 1.0.13 → 1.0.14

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