@wix/auto_sdk_events_ticket-definitions-v-2 1.0.20 → 1.0.21

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/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
  11. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +109 -0
  12. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
  13. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
  14. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +585 -0
  15. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
  16. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
  17. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +237 -0
  18. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
  19. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
  20. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +306 -0
  21. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
  22. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
  23. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +705 -0
  24. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
  25. package/build/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.mts → cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
  26. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1341 -0
  27. package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
  39. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +46 -0
  40. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
  41. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
  42. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +571 -0
  43. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
  44. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
  45. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +200 -0
  46. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
  47. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
  48. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +232 -0
  49. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
  50. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
  51. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +701 -0
  52. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
  53. package/build/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.ts → es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
  54. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1303 -0
  55. package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
  66. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +109 -0
  67. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
  68. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
  69. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +585 -0
  70. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
  71. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
  72. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +237 -0
  73. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
  74. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
  75. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +306 -0
  76. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
  77. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
  78. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +705 -0
  79. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
  80. package/build/internal/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.ts → cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
  81. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1341 -0
  82. package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
  93. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +46 -0
  94. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
  95. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
  96. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +571 -0
  97. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
  98. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
  99. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +200 -0
  100. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
  101. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
  102. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +232 -0
  103. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
  104. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
  105. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +701 -0
  106. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
  107. package/build/internal/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.mts → es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
  108. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1303 -0
  109. package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -179
  112. package/build/index.d.ts +0 -179
  113. package/build/index.js +0 -1885
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -1786
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -179
  118. package/build/internal/index.d.ts +0 -179
  119. package/build/internal/index.js +0 -1885
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -1786
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -754
  124. package/build/internal/meta.d.ts +0 -754
  125. package/build/internal/meta.js +0 -761
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -724
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -754
  130. package/build/meta.d.ts +0 -754
  131. package/build/meta.js +0 -761
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -724
  134. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,4206 @@
1
+ export interface TicketDefinition {
2
+ /**
3
+ * Ticket definition ID.
4
+ * @format GUID
5
+ * @readonly
6
+ */
7
+ id?: string | null;
8
+ /**
9
+ * Event ID to which the ticket definition belongs.
10
+ * @format GUID
11
+ * @immutable
12
+ */
13
+ eventId?: string | null;
14
+ /**
15
+ * Revision number, which increments by 1 each time the ticket definition is updated. To prevent conflicting changes, the existing revision must be used when updating a ticket definition.
16
+ * @readonly
17
+ */
18
+ revision?: string | null;
19
+ /**
20
+ * Date and time when the ticket definition was created.
21
+ * @readonly
22
+ */
23
+ createdDate?: Date | null;
24
+ /**
25
+ * Date and time when the ticket definition was updated.
26
+ * @readonly
27
+ */
28
+ updatedDate?: Date | null;
29
+ /**
30
+ * Ticket definition name.
31
+ * @minLength 1
32
+ * @maxLength 30
33
+ */
34
+ name?: string | null;
35
+ /**
36
+ * Ticket definition description.
37
+ * @maxLength 500
38
+ */
39
+ description?: string | null;
40
+ /**
41
+ * Ticket definition policy.
42
+ * @maxLength 1000
43
+ */
44
+ policyText?: string | null;
45
+ /** Whether this ticket definition is hidden to site visitors and can't be purchased. */
46
+ hidden?: boolean;
47
+ /**
48
+ * Whether the ticket has a limited maximum quantity.
49
+ * @readonly
50
+ */
51
+ limited?: boolean;
52
+ /** The maximum number of tickets that can be sold for the event when first defining the event. If a seating map is defined after you created a ticket definition, this property is ignored and `actualLimit` is used instead. */
53
+ initialLimit?: number | null;
54
+ /**
55
+ * The maximum number of tickets that can be sold for the event after adding a seating map to the event. If no seating map is defined, this property is the same as `initialLimit`.
56
+ * @readonly
57
+ */
58
+ actualLimit?: number | null;
59
+ /** Ticket pricing method. */
60
+ pricingMethod?: PricingMethod;
61
+ /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */
62
+ feeType?: FeeTypeEnumType;
63
+ /** Ticket sale period. */
64
+ salePeriod?: SalePeriod;
65
+ /**
66
+ * Ticket sale status.
67
+ * @readonly
68
+ */
69
+ saleStatus?: SaleStatusEnumStatus;
70
+ /**
71
+ * Ticket sales information. <br>
72
+ * **Note:** This field is only returned when `SALES_DETAILS` fieldset is included in the request.
73
+ */
74
+ salesDetails?: SalesDetails;
75
+ /**
76
+ * Number of tickets that can be purchased per checkout. <br>
77
+ * **Note:** If the `actuaLimit` or `salesDetails.unsoldCount` field value is smaller than `limitPerCheckout`, then it overrides this field.
78
+ * @readonly
79
+ * @max 50
80
+ */
81
+ limitPerCheckout?: number | null;
82
+ /** Data extensions. */
83
+ extendedFields?: ExtendedFields;
84
+ /**
85
+ * Associated event information. <br>
86
+ * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.
87
+ */
88
+ eventDetails?: EventDetails;
89
+ }
90
+ export interface SalePeriod {
91
+ /** Ticket sale start timestamp. */
92
+ startDate?: Date | null;
93
+ /** Ticket sale end timestamp. */
94
+ endDate?: Date | null;
95
+ /** Whether to display the ticket if it's not available to buy. */
96
+ displayNotOnSale?: boolean;
97
+ }
98
+ export interface PricingMethod extends PricingMethodPriceOneOf {
99
+ /** Same ticket price for everyone. */
100
+ fixedPrice?: CommonMoney;
101
+ /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). The price can be updated to a higher amount by a guest during the checkout. */
102
+ guestPrice?: CommonMoney;
103
+ /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
104
+ pricingOptions?: PricingOptions;
105
+ /**
106
+ * Ticket price type.
107
+ * @readonly
108
+ */
109
+ pricingType?: PricingTypeEnumType;
110
+ /**
111
+ * Whether the ticket is free. To create a free ticket, enter `0` in the `pricingMethod.fixedPrice.value` field.
112
+ * @readonly
113
+ */
114
+ free?: boolean;
115
+ }
116
+ /** @oneof */
117
+ export interface PricingMethodPriceOneOf {
118
+ /** Same ticket price for everyone. */
119
+ fixedPrice?: CommonMoney;
120
+ /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). The price can be updated to a higher amount by a guest during the checkout. */
121
+ guestPrice?: CommonMoney;
122
+ /** Sets of various ticket prices. For example, you can charge different prices for children and adults. */
123
+ pricingOptions?: PricingOptions;
124
+ }
125
+ /**
126
+ * Money.
127
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
128
+ */
129
+ export interface CommonMoney {
130
+ /**
131
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
132
+ * @format DECIMAL_VALUE
133
+ */
134
+ value?: string;
135
+ /**
136
+ * Currency code. Must be a valid [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code (e.g., USD).
137
+ * @format CURRENCY
138
+ */
139
+ currency?: string;
140
+ }
141
+ export interface PricingOptions {
142
+ /**
143
+ * Ticket price option details.
144
+ * @maxSize 100
145
+ */
146
+ optionDetails?: OptionDetails[];
147
+ }
148
+ export interface OptionDetails {
149
+ /**
150
+ * Ticket price option ID.
151
+ * @format GUID
152
+ */
153
+ optionId?: string | null;
154
+ /**
155
+ * Ticket price option name, such as "Child Ticket".
156
+ * @minLength 1
157
+ * @maxLength 200
158
+ */
159
+ name?: string | null;
160
+ /** Ticket price. */
161
+ price?: CommonMoney;
162
+ }
163
+ export declare enum PricingTypeEnumType {
164
+ /** Undefined pricing type. */
165
+ UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
166
+ /** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */
167
+ STANDARD = "STANDARD",
168
+ /** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
169
+ DONATION = "DONATION"
170
+ }
171
+ export declare enum FeeTypeEnumType {
172
+ /** Unknown fee type. */
173
+ UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
174
+ /** The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a ticket service fee of $0.25 will be deducted from the price and you'll get $9.75. */
175
+ FEE_INCLUDED = "FEE_INCLUDED",
176
+ /** The fee is shown in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer will see a ticket service fee of $0.25 and will pay $10.25 in total. */
177
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT",
178
+ /** Ticket service fee is not collected. Available only for free tickets and legacy users. */
179
+ NO_FEE = "NO_FEE"
180
+ }
181
+ export declare enum SaleStatusEnumStatus {
182
+ /** Undefined sale status. */
183
+ UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
184
+ /** Tickets are not on sale yet. */
185
+ SALE_SCHEDULED = "SALE_SCHEDULED",
186
+ /** Tickets are on sale. */
187
+ SALE_STARTED = "SALE_STARTED",
188
+ /** Tickets are not on sale. */
189
+ SALE_ENDED = "SALE_ENDED"
190
+ }
191
+ export interface SalesDetails {
192
+ /**
193
+ * Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
194
+ * @readonly
195
+ */
196
+ unsoldCount?: number | null;
197
+ /**
198
+ * Number of purchased tickets.
199
+ * @readonly
200
+ */
201
+ soldCount?: number | null;
202
+ /**
203
+ * Number of reserved tickets.
204
+ * @readonly
205
+ */
206
+ reservedCount?: number | null;
207
+ /**
208
+ * Whether the tickets are sold out.
209
+ * @readonly
210
+ */
211
+ soldOut?: boolean | null;
212
+ }
213
+ export interface ExtendedFields {
214
+ /**
215
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
216
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
217
+ *
218
+ * You can only access fields for which you have the appropriate permissions.
219
+ *
220
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
221
+ */
222
+ namespaces?: Record<string, Record<string, any>>;
223
+ }
224
+ export interface EventDetails {
225
+ /**
226
+ * Event title.
227
+ * @minLength 1
228
+ * @maxLength 120
229
+ * @readonly
230
+ */
231
+ title?: string | null;
232
+ /**
233
+ * Event short description.
234
+ * @maxLength 500
235
+ * @readonly
236
+ */
237
+ shortDescription?: string | null;
238
+ /**
239
+ * Event location.
240
+ * @readonly
241
+ */
242
+ location?: Location;
243
+ /**
244
+ * Event date and time settings.
245
+ * @readonly
246
+ */
247
+ dateAndTimeSettings?: DateAndTimeSettings;
248
+ /**
249
+ * Event page URL components.
250
+ * @readonly
251
+ */
252
+ eventPageUrl?: PageUrl;
253
+ /**
254
+ * Event status.
255
+ * @readonly
256
+ */
257
+ status?: Status;
258
+ }
259
+ export interface Location {
260
+ /**
261
+ * Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
262
+ * @maxLength 50
263
+ */
264
+ name?: string | null;
265
+ /** Location type. */
266
+ type?: LocationType;
267
+ /** Exact location address. */
268
+ address?: CommonAddress;
269
+ /** Whether the event location is TBD. */
270
+ locationTbd?: boolean | null;
271
+ }
272
+ export declare enum LocationType {
273
+ /** Unknown location type. */
274
+ UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
275
+ /** Event is on-site at a specific physical location. */
276
+ VENUE = "VENUE",
277
+ /** Event is online, such as a virtual video conference. */
278
+ ONLINE = "ONLINE"
279
+ }
280
+ /** Physical address */
281
+ export interface CommonAddress extends CommonAddressStreetOneOf {
282
+ /** Street address. */
283
+ streetAddress?: CommonStreetAddress;
284
+ /**
285
+ * Primary address information (street and building number).
286
+ * @maxLength 250
287
+ */
288
+ addressLine?: string | null;
289
+ /**
290
+ * 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
291
+ * @format COUNTRY
292
+ */
293
+ country?: string | null;
294
+ /**
295
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
296
+ * @maxLength 20
297
+ */
298
+ subdivision?: string | null;
299
+ /**
300
+ * City name.
301
+ * @maxLength 100
302
+ */
303
+ city?: string | null;
304
+ /**
305
+ * Zip or postal code.
306
+ * @maxLength 100
307
+ */
308
+ postalCode?: string | null;
309
+ /**
310
+ * Secondary address information (suite or apartment number and room number).
311
+ * @maxLength 250
312
+ */
313
+ addressLine2?: string | null;
314
+ }
315
+ /** @oneof */
316
+ export interface CommonAddressStreetOneOf {
317
+ /** Street address. */
318
+ streetAddress?: CommonStreetAddress;
319
+ /**
320
+ * Primary address information (street and building number).
321
+ * @maxLength 250
322
+ */
323
+ addressLine?: string | null;
324
+ }
325
+ export interface CommonStreetAddress {
326
+ /**
327
+ * Street number.
328
+ * @maxLength 100
329
+ */
330
+ number?: string;
331
+ /**
332
+ * Street name.
333
+ * @maxLength 250
334
+ */
335
+ name?: string;
336
+ }
337
+ export interface CommonAddressLocation {
338
+ /**
339
+ * Address latitude coordinates.
340
+ * @min -90
341
+ * @max 90
342
+ */
343
+ latitude?: number | null;
344
+ /**
345
+ * Address longitude coordinates.
346
+ * @min -180
347
+ * @max 180
348
+ */
349
+ longitude?: number | null;
350
+ }
351
+ export interface CommonSubdivision {
352
+ /**
353
+ * Short subdivision code.
354
+ * @maxLength 100
355
+ */
356
+ code?: string;
357
+ /**
358
+ * Subdivision full name.
359
+ * @maxLength 250
360
+ */
361
+ name?: string;
362
+ }
363
+ export declare enum SubdivisionSubdivisionType {
364
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
365
+ /** State */
366
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
367
+ /** County */
368
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
369
+ /** City/town */
370
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
371
+ /** Neighborhood/quarter */
372
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
373
+ /** Street/block */
374
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
375
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
376
+ COUNTRY = "COUNTRY"
377
+ }
378
+ export interface DateAndTimeSettings {
379
+ /** Whether the event date and time are TBD. */
380
+ dateAndTimeTbd?: boolean | null;
381
+ /**
382
+ * Message that is displayed when time and date is TBD.
383
+ * @maxLength 100
384
+ */
385
+ dateAndTimeTbdMessage?: string | null;
386
+ /** Event start date. */
387
+ startDate?: Date | null;
388
+ /** Event end date. */
389
+ endDate?: Date | null;
390
+ /**
391
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
392
+ * @maxLength 100
393
+ */
394
+ timeZoneId?: string | null;
395
+ /** Whether the end date is hidden in the formatted date and time. */
396
+ hideEndDate?: boolean | null;
397
+ /** Whether the time zone is displayed in the formatted schedule. */
398
+ showTimeZone?: boolean | null;
399
+ /**
400
+ * Repeating event status.
401
+ * @readonly
402
+ */
403
+ recurrenceStatus?: RecurrenceStatusStatus;
404
+ /** Event repetitions. */
405
+ recurringEvents?: Recurrences;
406
+ /** Formatted date and time settings. */
407
+ formatted?: Formatted;
408
+ }
409
+ export declare enum RecurrenceStatusStatus {
410
+ /** Unknown recurrance status. */
411
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
412
+ /** Event happens only once and can last multiple days. */
413
+ ONE_TIME = "ONE_TIME",
414
+ /** A series of events that repeat. */
415
+ RECURRING = "RECURRING",
416
+ /** Next event in a schedule of recurring events. */
417
+ RECURRING_UPCOMING = "RECURRING_UPCOMING",
418
+ /** Latest event that ended in a schedule of recurring events. */
419
+ RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
420
+ /** Latest canceled event in a schedule of recurring events */
421
+ RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
422
+ }
423
+ export interface Recurrences {
424
+ /**
425
+ * Individual event dates.
426
+ * @maxSize 1000
427
+ */
428
+ individualEventDates?: Occurrence[];
429
+ /**
430
+ * Recurring event category ID.
431
+ * @readonly
432
+ * @maxLength 100
433
+ */
434
+ categoryId?: string | null;
435
+ }
436
+ export interface Occurrence {
437
+ /** Event start date. */
438
+ startDate?: Date | null;
439
+ /** Event end date. */
440
+ endDate?: Date | null;
441
+ /**
442
+ * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
443
+ * @maxLength 100
444
+ */
445
+ timeZoneId?: string | null;
446
+ /** Whether the time zone is displayed in a formatted schedule. */
447
+ showTimeZone?: boolean;
448
+ }
449
+ export interface Formatted {
450
+ /**
451
+ * Formatted date and time representation. <br>
452
+ * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
453
+ * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
454
+ * @readonly
455
+ * @maxLength 500
456
+ */
457
+ dateAndTime?: string | null;
458
+ /**
459
+ * Formatted start date of the event. Empty for TBD schedules.
460
+ * @readonly
461
+ * @maxLength 500
462
+ */
463
+ startDate?: string | null;
464
+ /**
465
+ * Formatted start time of the event. Empty for TBD schedules.
466
+ * @readonly
467
+ * @maxLength 500
468
+ */
469
+ startTime?: string | null;
470
+ /**
471
+ * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
472
+ * @readonly
473
+ * @maxLength 500
474
+ */
475
+ endDate?: string | null;
476
+ /**
477
+ * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
478
+ * @readonly
479
+ * @maxLength 500
480
+ */
481
+ endTime?: string | null;
482
+ }
483
+ export interface PageUrl {
484
+ /**
485
+ * The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`).
486
+ * @maxLength 500
487
+ */
488
+ base?: string;
489
+ /**
490
+ * The path to the page. For example, `/product-page/a-product`.
491
+ * @maxLength 500
492
+ */
493
+ path?: string;
494
+ }
495
+ export declare enum Status {
496
+ /** Unknown event status. */
497
+ UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
498
+ /** Event is published and scheduled to start. */
499
+ UPCOMING = "UPCOMING",
500
+ /** Event has started. */
501
+ STARTED = "STARTED",
502
+ /** Event has ended. */
503
+ ENDED = "ENDED",
504
+ /** Event is canceled. */
505
+ CANCELED = "CANCELED",
506
+ /** Event is not public. */
507
+ DRAFT = "DRAFT"
508
+ }
509
+ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
510
+ /**
511
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
512
+ * @format GUID
513
+ */
514
+ metaSiteId?: string;
515
+ /**
516
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
517
+ * @format GUID
518
+ */
519
+ siteId?: string;
520
+ /** Invalidate by App */
521
+ app?: App;
522
+ /** Invalidate by page id */
523
+ page?: Page;
524
+ /** Invalidate by URI path */
525
+ uri?: URI;
526
+ /** Invalidate by file (for media files such as PDFs) */
527
+ file?: File;
528
+ /**
529
+ * tell us why you're invalidating the cache. You don't need to add your app name
530
+ * @maxLength 256
531
+ */
532
+ reason?: string | null;
533
+ /** Is local DS */
534
+ localDc?: boolean;
535
+ hardPurge?: boolean;
536
+ }
537
+ /** @oneof */
538
+ export interface InvalidateCacheGetByOneOf {
539
+ /**
540
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
541
+ * @format GUID
542
+ */
543
+ metaSiteId?: string;
544
+ /**
545
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
546
+ * @format GUID
547
+ */
548
+ siteId?: string;
549
+ /** Invalidate by App */
550
+ app?: App;
551
+ /** Invalidate by page id */
552
+ page?: Page;
553
+ /** Invalidate by URI path */
554
+ uri?: URI;
555
+ /** Invalidate by file (for media files such as PDFs) */
556
+ file?: File;
557
+ }
558
+ export interface App {
559
+ /**
560
+ * The AppDefId
561
+ * @minLength 1
562
+ */
563
+ appDefId?: string;
564
+ /**
565
+ * The instance Id
566
+ * @format GUID
567
+ */
568
+ instanceId?: string;
569
+ }
570
+ export interface Page {
571
+ /**
572
+ * the msid the page is on
573
+ * @format GUID
574
+ */
575
+ metaSiteId?: string;
576
+ /**
577
+ * Invalidate by Page ID
578
+ * @minLength 1
579
+ */
580
+ pageId?: string;
581
+ }
582
+ export interface URI {
583
+ /**
584
+ * the msid the URI is on
585
+ * @format GUID
586
+ */
587
+ metaSiteId?: string;
588
+ /**
589
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
590
+ * @minLength 1
591
+ */
592
+ uriPath?: string;
593
+ }
594
+ export interface File {
595
+ /**
596
+ * the msid the file is related to
597
+ * @format GUID
598
+ */
599
+ metaSiteId?: string;
600
+ /**
601
+ * Invalidate by filename (for media files such as PDFs)
602
+ * @minLength 1
603
+ * @maxLength 256
604
+ */
605
+ fileName?: string;
606
+ }
607
+ export interface SalePeriodUpdated {
608
+ /** Ticket definition sale period after update. */
609
+ afterUpdate?: SalePeriod;
610
+ }
611
+ export interface TicketDefinitionSaleStarted {
612
+ /** Ticket definition. */
613
+ ticketDefinition?: TicketDefinition;
614
+ }
615
+ export interface TicketDefinitionSaleEnded {
616
+ /** Ticket definition. */
617
+ ticketDefinition?: TicketDefinition;
618
+ }
619
+ export interface CreateTicketDefinitionRequest {
620
+ /** Ticket definition info. */
621
+ ticketDefinition: TicketDefinition;
622
+ /**
623
+ * Predefined sets of fields to return.
624
+ * @maxSize 5
625
+ */
626
+ fields?: Field[];
627
+ }
628
+ export declare enum Field {
629
+ /** Unknown requested field. */
630
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
631
+ /** Returns `salesDetails` in the response. */
632
+ SALES_DETAILS = "SALES_DETAILS",
633
+ /** Returns `eventDetails` in the response. */
634
+ EVENT_DETAILS = "EVENT_DETAILS"
635
+ }
636
+ export interface CreateTicketDefinitionResponse {
637
+ /** Created ticket definition. */
638
+ ticketDefinition?: TicketDefinition;
639
+ }
640
+ export interface UpdateTicketDefinitionRequest {
641
+ /** Ticket definition to update. */
642
+ ticketDefinition: TicketDefinition;
643
+ /**
644
+ * Predefined sets of fields to return.
645
+ * @maxSize 5
646
+ */
647
+ fields?: Field[];
648
+ }
649
+ export interface UpdateTicketDefinitionResponse {
650
+ /** The updated ticket definition. */
651
+ ticketDefinition?: TicketDefinition;
652
+ }
653
+ export interface GetTicketDefinitionRequest {
654
+ /**
655
+ * Ticket definition ID.
656
+ * @format GUID
657
+ */
658
+ ticketDefinitionId: string;
659
+ /**
660
+ * Predefined sets of fields to return.
661
+ * @maxSize 5
662
+ */
663
+ fields?: Field[];
664
+ }
665
+ export interface GetTicketDefinitionResponse {
666
+ /** The requested ticket definition. */
667
+ ticketDefinition?: TicketDefinition;
668
+ }
669
+ export interface DeleteTicketDefinitionRequest {
670
+ /**
671
+ * ID of the ticket definition to delete.
672
+ * @format GUID
673
+ */
674
+ ticketDefinitionId: string;
675
+ }
676
+ export interface DeleteTicketDefinitionResponse {
677
+ }
678
+ export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
679
+ /**
680
+ * Move the given `definitionId` before the referenced ticket definition.
681
+ * @format GUID
682
+ */
683
+ beforeDefinitionId?: string;
684
+ /**
685
+ * Move the given `definitionId` after the referenced ticket definition.
686
+ * @format GUID
687
+ */
688
+ afterDefinitionId?: string;
689
+ /**
690
+ * Event ID.
691
+ * @format GUID
692
+ */
693
+ eventId: string;
694
+ /**
695
+ * Ticket definition ID.
696
+ * @format GUID
697
+ */
698
+ ticketDefinitionId: string;
699
+ }
700
+ /** @oneof */
701
+ export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
702
+ /**
703
+ * Move the given `definitionId` before the referenced ticket definition.
704
+ * @format GUID
705
+ */
706
+ beforeDefinitionId?: string;
707
+ /**
708
+ * Move the given `definitionId` after the referenced ticket definition.
709
+ * @format GUID
710
+ */
711
+ afterDefinitionId?: string;
712
+ }
713
+ export interface ReorderTicketDefinitionsResponse {
714
+ }
715
+ export interface UpdateTicketDefinitionSortIndexRequest {
716
+ /**
717
+ * Ticket definition ID
718
+ * @format GUID
719
+ */
720
+ ticketDefinitionId?: string;
721
+ /** The revision of the ticket definition */
722
+ revision?: string;
723
+ /** the sort index of a ticket definition to set */
724
+ sortIndex?: number;
725
+ /**
726
+ * Requested fields.
727
+ * @maxSize 5
728
+ */
729
+ fields?: Field[];
730
+ }
731
+ export interface UpdateTicketDefinitionSortIndexResponse {
732
+ /** the updated ticket definition */
733
+ ticketDefinition?: TicketDefinition;
734
+ }
735
+ export interface QueryTicketDefinitionsRequest {
736
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
737
+ query: QueryV2;
738
+ /**
739
+ * Predefined sets of fields to return.
740
+ * @maxSize 5
741
+ */
742
+ fields?: Field[];
743
+ }
744
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
745
+ /** Paging options to limit and skip the number of items. */
746
+ paging?: Paging;
747
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
748
+ cursorPaging?: CursorPaging;
749
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "id": "2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5", "revision": {"$ne":"1"} }` */
750
+ filter?: Record<string, any> | null;
751
+ /**
752
+ * Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information.
753
+ * @maxSize 10
754
+ */
755
+ sort?: Sorting[];
756
+ }
757
+ /** @oneof */
758
+ export interface QueryV2PagingMethodOneOf {
759
+ /** Paging options to limit and skip the number of items. */
760
+ paging?: Paging;
761
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort` parameters. */
762
+ cursorPaging?: CursorPaging;
763
+ }
764
+ export interface Sorting {
765
+ /**
766
+ * Name of the field to sort by.
767
+ * @maxLength 100
768
+ */
769
+ fieldName?: string;
770
+ /** Defaults to `ASC` */
771
+ order?: SortOrder;
772
+ }
773
+ export declare enum SortOrder {
774
+ ASC = "ASC",
775
+ DESC = "DESC"
776
+ }
777
+ export interface Paging {
778
+ /** Number of items to load per page. */
779
+ limit?: number | null;
780
+ /** Number of items to skip in the current sort order. */
781
+ offset?: number | null;
782
+ }
783
+ export interface CursorPaging {
784
+ /**
785
+ * Number of items to load per page.
786
+ * @max 100
787
+ */
788
+ limit?: number | null;
789
+ /**
790
+ * Pointer to the next or previous page in the list of results.
791
+ * You can get the relevant cursor token
792
+ * from the `pagingMetadata` object in the previous call's response.
793
+ * Not relevant for the first request.
794
+ * @maxLength 16000
795
+ */
796
+ cursor?: string | null;
797
+ }
798
+ export interface QueryTicketDefinitionsResponse {
799
+ /** List of ticket definitions. */
800
+ ticketDefinitions?: TicketDefinition[];
801
+ /** Metadata for the paginated results. */
802
+ metadata?: PagingMetadataV2;
803
+ }
804
+ export interface PagingMetadataV2 {
805
+ /** Number of items returned in the response. */
806
+ count?: number | null;
807
+ /** Offset that was requested. */
808
+ offset?: number | null;
809
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
810
+ total?: number | null;
811
+ /** Flag that indicates the server failed to calculate the `total` field. */
812
+ tooManyToCount?: boolean | null;
813
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
814
+ cursors?: Cursors;
815
+ }
816
+ export interface Cursors {
817
+ /**
818
+ * Cursor pointing to next page in the list of results.
819
+ * @maxLength 36
820
+ */
821
+ next?: string | null;
822
+ /**
823
+ * Cursor pointing to previous page in the list of results.
824
+ * @maxLength 36
825
+ */
826
+ prev?: string | null;
827
+ }
828
+ export interface QueryAvailableTicketDefinitionsRequest {
829
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
830
+ query: QueryV2;
831
+ /**
832
+ * Predefined sets of fields to return.
833
+ * @maxSize 5
834
+ */
835
+ fields?: Field[];
836
+ }
837
+ export interface QueryAvailableTicketDefinitionsResponse {
838
+ /** List of ticket definitions. */
839
+ ticketDefinitions?: TicketDefinition[];
840
+ /** Metadata for the paginated results. */
841
+ metadata?: PagingMetadataV2;
842
+ }
843
+ export interface CountTicketDefinitionsRequest {
844
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
845
+ filter?: Record<string, any> | null;
846
+ /**
847
+ * Parameters to count ticket definitions by.
848
+ *
849
+ * - Max: 20 facets.
850
+ * @maxLength 100
851
+ * @maxSize 20
852
+ */
853
+ facet?: string[];
854
+ }
855
+ export interface CountTicketDefinitionsResponse {
856
+ /** Metadata for the paginated results. */
857
+ metadata?: PagingMetadataV2;
858
+ /** Filter facets. */
859
+ facets?: Record<string, FacetCounts>;
860
+ }
861
+ export interface FacetCounts {
862
+ /** Facet counts aggregated per value */
863
+ counts?: Record<string, number>;
864
+ }
865
+ export interface CountAvailableTicketDefinitionsRequest {
866
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
867
+ filter?: Record<string, any> | null;
868
+ }
869
+ export interface CountAvailableTicketDefinitionsResponse {
870
+ /** Metadata for the paginated results. */
871
+ metadata?: PagingMetadataV2;
872
+ }
873
+ export interface BulkDeleteTicketDefinitionsByFilterRequest {
874
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }` */
875
+ filter: Record<string, any> | null;
876
+ }
877
+ export interface BulkDeleteTicketDefinitionsByFilterResponse {
878
+ }
879
+ export interface ChangeCurrencyRequest {
880
+ /**
881
+ * Event ID.
882
+ * @format GUID
883
+ */
884
+ eventId: string;
885
+ /**
886
+ * Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
887
+ * @minLength 3
888
+ * @maxLength 3
889
+ */
890
+ currency: string;
891
+ }
892
+ export interface ChangeCurrencyResponse {
893
+ }
894
+ export interface BulkCopyTicketDefinitionsByEventIdRequest {
895
+ /**
896
+ * Origin instance ID.
897
+ * @format GUID
898
+ */
899
+ originInstanceId?: string | null;
900
+ /**
901
+ * Origin Event ID.
902
+ * @format GUID
903
+ */
904
+ originEventId?: string;
905
+ /**
906
+ * Target Event ID.
907
+ * @format GUID
908
+ */
909
+ targetEventId?: string;
910
+ }
911
+ export interface BulkCopyTicketDefinitionsByEventIdResponse {
912
+ /** Copied ticket definitions. */
913
+ definitions?: CopiedTicketDefinition[];
914
+ }
915
+ export interface CopiedTicketDefinition {
916
+ /**
917
+ * Origin Ticket definition ID.
918
+ * @format GUID
919
+ */
920
+ originTicketDefinitionId?: string;
921
+ /**
922
+ * Ticket definition ID.
923
+ * @format GUID
924
+ */
925
+ ticketDefinitionId?: string;
926
+ }
927
+ export interface UpdateFeeTypesBasedOnSettingsRequest {
928
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
929
+ query?: QueryV2;
930
+ }
931
+ export interface UpdateFeeTypesBasedOnSettingsResponse {
932
+ }
933
+ export interface EventDeleted {
934
+ /** Event deleted timestamp in ISO UTC format. */
935
+ timestamp?: Date | null;
936
+ /**
937
+ * Event ID.
938
+ * @format GUID
939
+ */
940
+ eventId?: string;
941
+ /** Event title. */
942
+ title?: string;
943
+ /**
944
+ * Event creator user ID.
945
+ * @format GUID
946
+ */
947
+ userId?: string | null;
948
+ }
949
+ export interface Empty {
950
+ }
951
+ export interface EventCanceled {
952
+ /** Event canceled timestamp in ISO UTC format. */
953
+ timestamp?: Date | null;
954
+ /**
955
+ * Event ID.
956
+ * @format GUID
957
+ */
958
+ eventId?: string;
959
+ /** Event title */
960
+ title?: string;
961
+ /**
962
+ * Event creator user ID.
963
+ * @format GUID
964
+ */
965
+ userId?: string | null;
966
+ /** True if at least one guest is registered to the event with any attendance status. */
967
+ hasGuests?: boolean | null;
968
+ }
969
+ export interface EventEnded {
970
+ /** Event end timestamp in ISO UTC format. */
971
+ timestamp?: Date | null;
972
+ /**
973
+ * Event ID.
974
+ * @format GUID
975
+ */
976
+ eventId?: string;
977
+ /** True if at least one guest is registered to the event with any attendance status. */
978
+ hasGuests?: boolean | null;
979
+ }
980
+ export interface EventCreated {
981
+ /** Event created timestamp in ISO UTC format. */
982
+ timestamp?: Date | null;
983
+ /**
984
+ * Event ID.
985
+ * @format GUID
986
+ */
987
+ eventId?: string;
988
+ /** Event location. */
989
+ location?: EventsLocation;
990
+ /** Event schedule configuration. */
991
+ scheduleConfig?: ScheduleConfig;
992
+ /** Event title. */
993
+ title?: string;
994
+ /**
995
+ * Event creator user ID.
996
+ * @maxLength 36
997
+ */
998
+ userId?: string | null;
999
+ /** Event status. */
1000
+ status?: EventStatus;
1001
+ /**
1002
+ * Instance ID. Indicates the original app instance which current event was derived from.
1003
+ * @format GUID
1004
+ */
1005
+ derivedFromInstanceId?: string | null;
1006
+ /**
1007
+ * Event ID. Indicates the original event which current event was derived from.
1008
+ * @format GUID
1009
+ */
1010
+ derivedFromEventId?: string | null;
1011
+ /** Event that was created. */
1012
+ event?: Event;
1013
+ }
1014
+ export interface EventsLocation {
1015
+ /**
1016
+ * Location name.
1017
+ * @maxLength 50
1018
+ */
1019
+ name?: string | null;
1020
+ /** Location map coordinates. */
1021
+ coordinates?: MapCoordinates;
1022
+ /**
1023
+ * Single line address representation.
1024
+ * @maxLength 300
1025
+ */
1026
+ address?: string | null;
1027
+ /** Location type. */
1028
+ type?: LocationLocationType;
1029
+ /**
1030
+ * Full address derived from formatted single line `address`.
1031
+ * When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
1032
+ * If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
1033
+ *
1034
+ * Migration notes:
1035
+ * - `full_address.formatted_address` is equivalent to `address`.
1036
+ * - `full_address.geocode` is equivalent to `coordinates`.
1037
+ */
1038
+ fullAddress?: Address;
1039
+ /**
1040
+ * Defines event location as TBD (To Be Determined).
1041
+ * When event location is not yet defined, `name` is displayed instead of location address.
1042
+ * `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
1043
+ */
1044
+ tbd?: boolean | null;
1045
+ }
1046
+ export interface MapCoordinates {
1047
+ /**
1048
+ * Latitude.
1049
+ * @min -90
1050
+ * @max 90
1051
+ */
1052
+ lat?: number;
1053
+ /**
1054
+ * Longitude.
1055
+ * @min -180
1056
+ * @max 180
1057
+ */
1058
+ lng?: number;
1059
+ }
1060
+ export declare enum LocationLocationType {
1061
+ VENUE = "VENUE",
1062
+ ONLINE = "ONLINE"
1063
+ }
1064
+ /** Physical address */
1065
+ export interface Address extends AddressStreetOneOf {
1066
+ /** a break down of the street to number and street name */
1067
+ streetAddress?: StreetAddress;
1068
+ /** Main address line (usually street and number) as free text */
1069
+ addressLine?: string | null;
1070
+ /**
1071
+ * country code
1072
+ * @format COUNTRY
1073
+ */
1074
+ country?: string | null;
1075
+ /** subdivision (usually state or region) code according to ISO 3166-2 */
1076
+ subdivision?: string | null;
1077
+ /** city name */
1078
+ city?: string | null;
1079
+ /** zip/postal code */
1080
+ postalCode?: string | null;
1081
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
1082
+ addressLine2?: string | null;
1083
+ /** A string containing the human-readable address of this location */
1084
+ formattedAddress?: string | null;
1085
+ /** Free text for human-to-human textual orientation aid purposes */
1086
+ hint?: string | null;
1087
+ /** coordinates of the physical address */
1088
+ geocode?: AddressLocation;
1089
+ /** country full-name */
1090
+ countryFullname?: string | null;
1091
+ /**
1092
+ * multi-level subdivisions from top to bottom
1093
+ * @maxSize 6
1094
+ */
1095
+ subdivisions?: Subdivision[];
1096
+ }
1097
+ /** @oneof */
1098
+ export interface AddressStreetOneOf {
1099
+ /** a break down of the street to number and street name */
1100
+ streetAddress?: StreetAddress;
1101
+ /** Main address line (usually street and number) as free text */
1102
+ addressLine?: string | null;
1103
+ }
1104
+ export interface StreetAddress {
1105
+ /** street number */
1106
+ number?: string;
1107
+ /** street name */
1108
+ name?: string;
1109
+ }
1110
+ export interface AddressLocation {
1111
+ /**
1112
+ * address latitude coordinates
1113
+ * @min -90
1114
+ * @max 90
1115
+ */
1116
+ latitude?: number | null;
1117
+ /**
1118
+ * address longitude coordinates
1119
+ * @min -180
1120
+ * @max 180
1121
+ */
1122
+ longitude?: number | null;
1123
+ }
1124
+ export interface Subdivision {
1125
+ /** subdivision short code */
1126
+ code?: string;
1127
+ /** subdivision full-name */
1128
+ name?: string;
1129
+ }
1130
+ export declare enum SubdivisionType {
1131
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
1132
+ /** State */
1133
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
1134
+ /** County */
1135
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
1136
+ /** City/town */
1137
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
1138
+ /** Neighborhood/quarter */
1139
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
1140
+ /** Street/block */
1141
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
1142
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
1143
+ COUNTRY = "COUNTRY"
1144
+ }
1145
+ export interface ScheduleConfig {
1146
+ /**
1147
+ * Defines event as TBD (To Be Determined) schedule.
1148
+ * When event time is not yet defined, TBD message is displayed instead of event start and end times.
1149
+ * `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
1150
+ */
1151
+ scheduleTbd?: boolean;
1152
+ /**
1153
+ * TBD message.
1154
+ * @maxLength 100
1155
+ */
1156
+ scheduleTbdMessage?: string | null;
1157
+ /** Event start timestamp. */
1158
+ startDate?: Date | null;
1159
+ /** Event end timestamp. */
1160
+ endDate?: Date | null;
1161
+ /**
1162
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
1163
+ * @maxLength 100
1164
+ */
1165
+ timeZoneId?: string | null;
1166
+ /** Whether end date is hidden in the formatted schedule. */
1167
+ endDateHidden?: boolean;
1168
+ /** Whether time zone is displayed in formatted schedule. */
1169
+ showTimeZone?: boolean;
1170
+ /** Event recurrences. */
1171
+ recurrences?: EventsRecurrences;
1172
+ }
1173
+ export interface EventsRecurrences {
1174
+ /**
1175
+ * Event occurrences.
1176
+ * @maxSize 1000
1177
+ */
1178
+ occurrences?: EventsOccurrence[];
1179
+ /**
1180
+ * Recurring event category ID.
1181
+ * @readonly
1182
+ */
1183
+ categoryId?: string | null;
1184
+ /**
1185
+ * Recurrence status.
1186
+ * @readonly
1187
+ */
1188
+ status?: EventsRecurrenceStatusStatus;
1189
+ }
1190
+ export interface EventsOccurrence {
1191
+ /** Event start timestamp. */
1192
+ startDate?: Date | null;
1193
+ /** Event end timestamp. */
1194
+ endDate?: Date | null;
1195
+ /**
1196
+ * Event time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
1197
+ * @maxLength 100
1198
+ */
1199
+ timeZoneId?: string | null;
1200
+ /** Whether time zone is displayed in formatted schedule. */
1201
+ showTimeZone?: boolean;
1202
+ }
1203
+ export declare enum EventsRecurrenceStatusStatus {
1204
+ /** Event occurs only once. */
1205
+ ONE_TIME = "ONE_TIME",
1206
+ /** Event is recurring. */
1207
+ RECURRING = "RECURRING",
1208
+ /** Marks the next upcoming occurrence of the recurring event. */
1209
+ RECURRING_NEXT = "RECURRING_NEXT",
1210
+ /** Marks the most recent ended occurrence of the recurring event. */
1211
+ RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
1212
+ /** Marks the most recent canceled occurrence of the recurring event. */
1213
+ RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
1214
+ }
1215
+ export declare enum EventStatus {
1216
+ /** Event is public and scheduled to start */
1217
+ SCHEDULED = "SCHEDULED",
1218
+ /** Event has started */
1219
+ STARTED = "STARTED",
1220
+ /** Event has ended */
1221
+ ENDED = "ENDED",
1222
+ /** Event was canceled */
1223
+ CANCELED = "CANCELED"
1224
+ }
1225
+ export interface Event {
1226
+ /**
1227
+ * Event ID.
1228
+ * @format GUID
1229
+ * @readonly
1230
+ */
1231
+ id?: string;
1232
+ /** Event location. */
1233
+ location?: EventsLocation;
1234
+ /** Event scheduling. */
1235
+ scheduling?: Scheduling;
1236
+ /** Event title. */
1237
+ title?: string;
1238
+ /** Event description. */
1239
+ description?: string;
1240
+ /** Rich-text content displayed in Wix UI - "About Event" section (HTML). */
1241
+ about?: string;
1242
+ /** Main event image. */
1243
+ mainImage?: Image;
1244
+ /** Event slug URL (generated from event title). */
1245
+ slug?: string;
1246
+ /** ISO 639-1 language code of the event (used in content translations). */
1247
+ language?: string;
1248
+ /** Event creation timestamp. */
1249
+ created?: Date | null;
1250
+ /** Event modified timestamp. */
1251
+ modified?: Date | null;
1252
+ /** Event status. */
1253
+ status?: EventStatus;
1254
+ /** RSVP or ticketing registration details. */
1255
+ registration?: Registration;
1256
+ /** "Add to calendar" URLs. */
1257
+ calendarLinks?: CalendarLinks;
1258
+ /** Event page URL components. */
1259
+ eventPageUrl?: SiteUrl;
1260
+ /** Event registration form. */
1261
+ form?: Form;
1262
+ /** Event dashboard summary of RSVP / ticket sales. */
1263
+ dashboard?: Dashboard;
1264
+ /** Instance ID of the site where event is hosted. */
1265
+ instanceId?: string;
1266
+ /** Guest list configuration. */
1267
+ guestListConfig?: GuestListConfig;
1268
+ /**
1269
+ * Event creator user ID.
1270
+ * @maxLength 36
1271
+ */
1272
+ userId?: string;
1273
+ /** Event discussion feed. For internal use. */
1274
+ feed?: Feed;
1275
+ /** Online conferencing details. */
1276
+ onlineConferencing?: OnlineConferencing;
1277
+ /** SEO settings. */
1278
+ seoSettings?: SeoSettings;
1279
+ /** Assigned contacts label key. */
1280
+ assignedContactsLabel?: string | null;
1281
+ /** Agenda details. */
1282
+ agenda?: Agenda;
1283
+ /** Categories this event is assigned to. */
1284
+ categories?: Category[];
1285
+ /** Visual settings for event. */
1286
+ eventDisplaySettings?: EventDisplaySettings;
1287
+ /** Rich content displayed in Wix UI - "About Event" section. Successor to `about` field. */
1288
+ longDescription?: RichContent;
1289
+ /**
1290
+ * Event publish timestamp.
1291
+ * @readonly
1292
+ */
1293
+ publishedDate?: Date | null;
1294
+ }
1295
+ export interface Scheduling {
1296
+ /** Schedule configuration. */
1297
+ config?: ScheduleConfig;
1298
+ /** Formatted schedule representation. */
1299
+ formatted?: string;
1300
+ /** Formatted start date of the event (empty for TBD schedules). */
1301
+ startDateFormatted?: string;
1302
+ /** Formatted start time of the event (empty for TBD schedules). */
1303
+ startTimeFormatted?: string;
1304
+ /** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
1305
+ endDateFormatted?: string;
1306
+ /** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
1307
+ endTimeFormatted?: string;
1308
+ }
1309
+ export interface Image {
1310
+ /**
1311
+ * WixMedia image ID.
1312
+ * @minLength 1
1313
+ * @maxLength 200
1314
+ */
1315
+ id?: string | null;
1316
+ /** Image URL. */
1317
+ url?: string;
1318
+ /** Original image height. */
1319
+ height?: number | null;
1320
+ /** Original image width. */
1321
+ width?: number | null;
1322
+ /** Image alt text. Optional. */
1323
+ altText?: string | null;
1324
+ }
1325
+ export interface Registration {
1326
+ /** Event type. */
1327
+ type?: EventType;
1328
+ /** Event registration status. */
1329
+ status?: RegistrationStatus;
1330
+ /** RSVP collection details. */
1331
+ rsvpCollection?: RsvpCollection;
1332
+ /** Ticketing details. */
1333
+ ticketing?: Ticketing;
1334
+ /** External registration details. */
1335
+ external?: ExternalEvent;
1336
+ /** Types of users allowed to register. */
1337
+ restrictedTo?: VisitorType;
1338
+ /** Initial event type which was set when creating an event. */
1339
+ initialType?: EventType;
1340
+ }
1341
+ export declare enum EventType {
1342
+ /** Type not available for this request fieldset */
1343
+ NA_EVENT_TYPE = "NA_EVENT_TYPE",
1344
+ /** Registration via RSVP */
1345
+ RSVP = "RSVP",
1346
+ /** Registration via ticket purchase */
1347
+ TICKETS = "TICKETS",
1348
+ /** External registration */
1349
+ EXTERNAL = "EXTERNAL",
1350
+ /** Registration not available */
1351
+ NO_REGISTRATION = "NO_REGISTRATION"
1352
+ }
1353
+ export declare enum RegistrationStatus {
1354
+ /** Registration status is not applicable */
1355
+ NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
1356
+ /** Registration to event is closed */
1357
+ CLOSED = "CLOSED",
1358
+ /** Registration to event is closed manually */
1359
+ CLOSED_MANUALLY = "CLOSED_MANUALLY",
1360
+ /** Registration is open via RSVP */
1361
+ OPEN_RSVP = "OPEN_RSVP",
1362
+ /** Registration to event waitlist is open via RSVP */
1363
+ OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
1364
+ /** Registration is open via ticket purchase */
1365
+ OPEN_TICKETS = "OPEN_TICKETS",
1366
+ /** Registration is open via external URL */
1367
+ OPEN_EXTERNAL = "OPEN_EXTERNAL",
1368
+ /** Registration will be open via RSVP */
1369
+ SCHEDULED_RSVP = "SCHEDULED_RSVP"
1370
+ }
1371
+ export interface RsvpCollection {
1372
+ /** RSVP collection configuration. */
1373
+ config?: RsvpCollectionConfig;
1374
+ }
1375
+ export interface RsvpCollectionConfig {
1376
+ /** Defines the supported RSVP statuses. */
1377
+ rsvpStatusOptions?: RsvpStatusOptions;
1378
+ /**
1379
+ * Total guest limit available to register to the event.
1380
+ * Additional guests per RSVP are counted towards total guests.
1381
+ */
1382
+ limit?: number | null;
1383
+ /** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
1384
+ waitlist?: boolean;
1385
+ /** Registration start timestamp. */
1386
+ startDate?: Date | null;
1387
+ /** Registration end timestamp. */
1388
+ endDate?: Date | null;
1389
+ }
1390
+ export declare enum RsvpStatusOptions {
1391
+ /** Only YES RSVP status is available for RSVP registration */
1392
+ YES_ONLY = "YES_ONLY",
1393
+ /** YES and NO RSVP status options are available for the registration */
1394
+ YES_AND_NO = "YES_AND_NO"
1395
+ }
1396
+ export interface Ticketing {
1397
+ /**
1398
+ * Deprecated.
1399
+ * @deprecated
1400
+ */
1401
+ lowestPrice?: string | null;
1402
+ /**
1403
+ * Deprecated.
1404
+ * @deprecated
1405
+ */
1406
+ highestPrice?: string | null;
1407
+ /** Currency used in event transactions. */
1408
+ currency?: string | null;
1409
+ /** Ticketing configuration. */
1410
+ config?: TicketingConfig;
1411
+ /**
1412
+ * Price of lowest priced ticket.
1413
+ * @readonly
1414
+ */
1415
+ lowestTicketPrice?: Money;
1416
+ /**
1417
+ * Price of highest priced ticket.
1418
+ * @readonly
1419
+ */
1420
+ highestTicketPrice?: Money;
1421
+ /**
1422
+ * Formatted price of lowest priced ticket.
1423
+ * @readonly
1424
+ */
1425
+ lowestTicketPriceFormatted?: string | null;
1426
+ /**
1427
+ * Formatted price of highest priced ticket.
1428
+ * @readonly
1429
+ */
1430
+ highestTicketPriceFormatted?: string | null;
1431
+ /**
1432
+ * Whether all tickets are sold for this event.
1433
+ * @readonly
1434
+ */
1435
+ soldOut?: boolean | null;
1436
+ }
1437
+ export interface TicketingConfig {
1438
+ /** Whether the form must be filled out separately for each ticket. */
1439
+ guestAssignedTickets?: boolean;
1440
+ /** Tax configuration. */
1441
+ taxConfig?: TaxConfig;
1442
+ /**
1443
+ * Limit of tickets that can be purchased per order, default 20.
1444
+ * @max 50
1445
+ */
1446
+ ticketLimitPerOrder?: number;
1447
+ /**
1448
+ * Duration for which the tickets being bought are reserved.
1449
+ * @min 5
1450
+ * @max 30
1451
+ */
1452
+ reservationDurationInMinutes?: number | null;
1453
+ }
1454
+ export interface TaxConfig {
1455
+ /** Tax application settings. */
1456
+ type?: TaxType;
1457
+ /**
1458
+ * Tax name.
1459
+ * @minLength 1
1460
+ * @maxLength 10
1461
+ */
1462
+ name?: string | null;
1463
+ /**
1464
+ * Tax rate (e.g.,`21.55`).
1465
+ * @decimalValue options { gte:0.001, lte:100, maxScale:3 }
1466
+ */
1467
+ rate?: string | null;
1468
+ /** Applies taxes for donations, default true. */
1469
+ appliesToDonations?: boolean | null;
1470
+ }
1471
+ export declare enum TaxType {
1472
+ /** Tax is included in the ticket price. */
1473
+ INCLUDED = "INCLUDED",
1474
+ /** Tax is added to the order at the checkout. */
1475
+ ADDED = "ADDED",
1476
+ /** Tax is added to the final total at the checkout. */
1477
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
1478
+ }
1479
+ export interface Money {
1480
+ /**
1481
+ * *Deprecated:** Use `value` instead.
1482
+ * @format DECIMAL_VALUE
1483
+ * @deprecated
1484
+ */
1485
+ amount?: string;
1486
+ /**
1487
+ * ISO 4217 format of the currency e.g., `USD`.
1488
+ * @format CURRENCY
1489
+ */
1490
+ currency?: string;
1491
+ /**
1492
+ * 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.
1493
+ * @format DECIMAL_VALUE
1494
+ */
1495
+ value?: string | null;
1496
+ }
1497
+ export interface ExternalEvent {
1498
+ /** External event registration URL. */
1499
+ registration?: string;
1500
+ }
1501
+ export declare enum VisitorType {
1502
+ /** Site visitor (including member) */
1503
+ VISITOR = "VISITOR",
1504
+ /** Site member */
1505
+ MEMBER = "MEMBER",
1506
+ /** Site visitor or member */
1507
+ VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
1508
+ }
1509
+ export interface CalendarLinks {
1510
+ /** "Add to Google calendar" URL. */
1511
+ google?: string;
1512
+ /** "Download ICS calendar file" URL. */
1513
+ ics?: string;
1514
+ }
1515
+ /** Site URL components */
1516
+ export interface SiteUrl {
1517
+ /**
1518
+ * Base URL. For premium sites, this will be the domain.
1519
+ * For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
1520
+ */
1521
+ base?: string;
1522
+ /** The path to that page - e.g `/my-events/weekly-meetup-2` */
1523
+ path?: string;
1524
+ }
1525
+ /**
1526
+ * The form defines which elements are rendered in the Wix UI during the registration process (RSVP or checkout).
1527
+ * It also contains customizable messages and labels.
1528
+ *
1529
+ *
1530
+ * A form is an ordered list of controls (blocks), which accept guest information into a field input.
1531
+ *
1532
+ * Each control contains one or more nested inputs. For example, `Name` control has two inputs:
1533
+ * - First Name
1534
+ * - Last Name
1535
+ *
1536
+ * By default, name and email controls are always required and are pinned to the top of the form.
1537
+ */
1538
+ export interface Form {
1539
+ /** Nested fields as an ordered list. */
1540
+ controls?: InputControl[];
1541
+ /** Set of configured form messages. */
1542
+ messages?: FormMessages;
1543
+ }
1544
+ /**
1545
+ * A block of nested fields.
1546
+ * Used to aggregate similar inputs like First Name and Last Name.
1547
+ */
1548
+ export interface InputControl {
1549
+ /** Field control type. */
1550
+ type?: InputControlType;
1551
+ /** Whether control is mandatory (such as name & email). When true, only label can be changed. */
1552
+ system?: boolean;
1553
+ /**
1554
+ * Deprecated: Use `id`.
1555
+ * @deprecated
1556
+ */
1557
+ name?: string;
1558
+ /** Child inputs. */
1559
+ inputs?: Input[];
1560
+ /**
1561
+ * Deprecated: use `inputs.label`.
1562
+ * @deprecated
1563
+ */
1564
+ label?: string;
1565
+ /** Field controls are sorted by this value in ascending order. */
1566
+ orderIndex?: number;
1567
+ /** Unique control ID. */
1568
+ id?: string;
1569
+ /**
1570
+ * Whether input control is deleted.
1571
+ * @readonly
1572
+ */
1573
+ deleted?: boolean | null;
1574
+ }
1575
+ export declare enum InputControlType {
1576
+ /** Single text value field. */
1577
+ INPUT = "INPUT",
1578
+ /** Single text value field. */
1579
+ TEXTAREA = "TEXTAREA",
1580
+ /** Single-choice field of predefined values. */
1581
+ DROPDOWN = "DROPDOWN",
1582
+ /** Single-choice field of predefined values. */
1583
+ RADIO = "RADIO",
1584
+ /** Multiple-choice field of predefined values. */
1585
+ CHECKBOX = "CHECKBOX",
1586
+ /** First and last name fields. */
1587
+ NAME = "NAME",
1588
+ /** Additional guests and respective guest names fields. */
1589
+ GUEST_CONTROL = "GUEST_CONTROL",
1590
+ /** Single-line address field. */
1591
+ ADDRESS_SHORT = "ADDRESS_SHORT",
1592
+ /** Full address field. */
1593
+ ADDRESS_FULL = "ADDRESS_FULL",
1594
+ /** Year, month and day fields. */
1595
+ DATE = "DATE"
1596
+ }
1597
+ /** An input of one or multiple text values */
1598
+ export interface Input {
1599
+ /** Field name. */
1600
+ name?: string;
1601
+ /**
1602
+ * Deprecated: use `ValueType.TEXT_ARRAY`.
1603
+ * @deprecated
1604
+ */
1605
+ array?: boolean;
1606
+ /** Main field label */
1607
+ label?: string;
1608
+ /** Additional labels for multi-valued fields such as address. */
1609
+ additionalLabels?: Record<string, string>;
1610
+ /** Predefined choice options for fields, such as dropdown. */
1611
+ options?: string[];
1612
+ /** Whether field is mandatory. */
1613
+ mandatory?: boolean;
1614
+ /** Maximum number of accepted characters (relevant for text fields). */
1615
+ maxLength?: number;
1616
+ /**
1617
+ * Type which determines field format.
1618
+ * Used to validate submitted response.
1619
+ */
1620
+ type?: ValueType;
1621
+ /**
1622
+ * A maximum accepted values for array input.
1623
+ * Only applicable for inputs of valueType: TEXT_ARRAY.
1624
+ */
1625
+ maxSize?: number | null;
1626
+ /**
1627
+ * Preselected option.
1628
+ * Currently only applicable for dropdown.
1629
+ */
1630
+ defaultOptionSelection?: OptionSelection;
1631
+ /**
1632
+ * Additional labels for multi-valued fields such as address.
1633
+ * @readonly
1634
+ */
1635
+ labels?: Label[];
1636
+ }
1637
+ export declare enum ValueType {
1638
+ TEXT = "TEXT",
1639
+ NUMBER = "NUMBER",
1640
+ TEXT_ARRAY = "TEXT_ARRAY",
1641
+ DATE_TIME = "DATE_TIME",
1642
+ ADDRESS = "ADDRESS"
1643
+ }
1644
+ /**
1645
+ * Describes initially selected option when an input has multiple choices.
1646
+ * Defaults to first (0th) option if not configured.
1647
+ */
1648
+ export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
1649
+ /**
1650
+ * 0-based index from predefined `input.options` which is selected initially.
1651
+ * @max 199
1652
+ */
1653
+ optionIndex?: number;
1654
+ /**
1655
+ * Placeholder hint describing expected choices (such as "Please select").
1656
+ * Considered an empty choice.
1657
+ * @maxLength 200
1658
+ */
1659
+ placeholderText?: string;
1660
+ }
1661
+ /** @oneof */
1662
+ export interface OptionSelectionSelectedOptionOneOf {
1663
+ /**
1664
+ * 0-based index from predefined `input.options` which is selected initially.
1665
+ * @max 199
1666
+ */
1667
+ optionIndex?: number;
1668
+ /**
1669
+ * Placeholder hint describing expected choices (such as "Please select").
1670
+ * Considered an empty choice.
1671
+ * @maxLength 200
1672
+ */
1673
+ placeholderText?: string;
1674
+ }
1675
+ export interface Label {
1676
+ /** Field name. */
1677
+ name?: string;
1678
+ /** Field label. */
1679
+ label?: string;
1680
+ }
1681
+ /**
1682
+ * Defines form messages shown in UI before, during, and after registration flow.
1683
+ * It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
1684
+ */
1685
+ export interface FormMessages {
1686
+ /** RSVP form messages. */
1687
+ rsvp?: RsvpFormMessages;
1688
+ /** Checkout form messages. */
1689
+ checkout?: CheckoutFormMessages;
1690
+ /** Messages shown when event registration is closed. */
1691
+ registrationClosed?: RegistrationClosedMessages;
1692
+ /** Messages shown when event tickets are unavailable. */
1693
+ ticketsUnavailable?: TicketsUnavailableMessages;
1694
+ }
1695
+ export interface RsvpFormMessages {
1696
+ /** Label text indicating RSVP `YES` response. */
1697
+ rsvpYesOption?: string;
1698
+ /** Label text indicating RSVP `NO` response. */
1699
+ rsvpNoOption?: string;
1700
+ /** Messages shown for RSVP = `YES`. */
1701
+ positiveMessages?: Positive;
1702
+ /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */
1703
+ waitlistMessages?: Positive;
1704
+ /** Messages shown for RSVP = `NO`. */
1705
+ negativeMessages?: Negative;
1706
+ /** "Submit form" call-to-action label text. */
1707
+ submitActionLabel?: string;
1708
+ }
1709
+ /** Confirmation messages shown after registration. */
1710
+ export interface PositiveResponseConfirmation {
1711
+ /** Confirmation message title. */
1712
+ title?: string;
1713
+ /** Confirmation message text. */
1714
+ message?: string;
1715
+ /** "Add to calendar" call-to-action label text. */
1716
+ addToCalendarActionLabel?: string;
1717
+ /** "Share event" call-to-action label text. */
1718
+ shareActionLabel?: string;
1719
+ }
1720
+ /** Confirmation messages shown after registration. */
1721
+ export interface NegativeResponseConfirmation {
1722
+ /** Confirmation message title. */
1723
+ title?: string;
1724
+ /** "Share event" call-to-action label text. */
1725
+ shareActionLabel?: string;
1726
+ }
1727
+ /** Set of messages shown during registration when RSVP response is positive. */
1728
+ export interface Positive {
1729
+ /** Main form title for positive response. */
1730
+ title?: string;
1731
+ /** Confirmation messages shown after registration. */
1732
+ confirmation?: PositiveResponseConfirmation;
1733
+ }
1734
+ /** A set of messages shown during registration with negative response */
1735
+ export interface Negative {
1736
+ /** Main form title for negative response. */
1737
+ title?: string;
1738
+ /** Confirmation messages shown after registration. */
1739
+ confirmation?: NegativeResponseConfirmation;
1740
+ }
1741
+ export interface CheckoutFormMessages {
1742
+ /** Main form title for response. */
1743
+ title?: string;
1744
+ /** Submit form call-to-action label text. */
1745
+ submitActionLabel?: string;
1746
+ /** Confirmation messages shown after checkout. */
1747
+ confirmation?: ResponseConfirmation;
1748
+ }
1749
+ /** Confirmation messages shown after checkout. */
1750
+ export interface ResponseConfirmation {
1751
+ /** Confirmation message title. */
1752
+ title?: string;
1753
+ /** Confirmation message text. */
1754
+ message?: string;
1755
+ /** "Download tickets" call-to-action label text. */
1756
+ downloadTicketsLabel?: string;
1757
+ /** "Add to calendar" call-to-action label text. */
1758
+ addToCalendarLabel?: string;
1759
+ /** "Share event" call-to-action label text. */
1760
+ shareEventLabel?: string;
1761
+ }
1762
+ export interface RegistrationClosedMessages {
1763
+ /** Message shown when event registration is closed. */
1764
+ message?: string;
1765
+ /** "Explore other events" call-to-action label text. */
1766
+ exploreEventsActionLabel?: string;
1767
+ }
1768
+ export interface TicketsUnavailableMessages {
1769
+ /** Message shown when event tickets are unavailable. */
1770
+ message?: string;
1771
+ /** "Explore other events" call-to-action label text. */
1772
+ exploreEventsActionLabel?: string;
1773
+ }
1774
+ export interface Dashboard {
1775
+ /** Guest RSVP summary. */
1776
+ rsvpSummary?: RsvpSummary;
1777
+ /**
1778
+ * Summary of revenue and tickets sold.
1779
+ * (Archived orders are not included).
1780
+ */
1781
+ ticketingSummary?: TicketingSummary;
1782
+ }
1783
+ export interface RsvpSummary {
1784
+ /** Total number of RSVPs. */
1785
+ total?: number;
1786
+ /** Number of RSVPs with status `YES`. */
1787
+ yes?: number;
1788
+ /** Number of RSVPs with status `NO`. */
1789
+ no?: number;
1790
+ /** Number of RSVPs in waitlist. */
1791
+ waitlist?: number;
1792
+ }
1793
+ export interface TicketingSummary {
1794
+ /** Number of tickets sold. */
1795
+ tickets?: number;
1796
+ /**
1797
+ * Total revenue, excluding fees.
1798
+ * (taxes and payment provider fees are not deducted.)
1799
+ */
1800
+ revenue?: Money;
1801
+ /** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
1802
+ currencyLocked?: boolean;
1803
+ /** Number of orders placed. */
1804
+ orders?: number;
1805
+ /** Total balance of confirmed transactions. */
1806
+ totalSales?: Money;
1807
+ }
1808
+ export interface GuestListConfig {
1809
+ /** Whether members can see other members attending the event (defaults to true). */
1810
+ publicGuestList?: boolean;
1811
+ }
1812
+ export interface Feed {
1813
+ /** Event discussion feed token. */
1814
+ token?: string;
1815
+ }
1816
+ export interface OnlineConferencing {
1817
+ config?: OnlineConferencingConfig;
1818
+ session?: OnlineConferencingSession;
1819
+ }
1820
+ export interface OnlineConferencingConfig {
1821
+ /**
1822
+ * Whether online conferencing is enabled (not supported for TBD schedules).
1823
+ * When enabled, links to join conferencing are generated and provided to guests.
1824
+ */
1825
+ enabled?: boolean;
1826
+ /**
1827
+ * Conferencing provider ID.
1828
+ * @format GUID
1829
+ */
1830
+ providerId?: string | null;
1831
+ /** Conference type */
1832
+ conferenceType?: ConferenceType;
1833
+ }
1834
+ export declare enum ConferenceType {
1835
+ /** Everyone in the meeting can publish and subscribe video and audio. */
1836
+ MEETING = "MEETING",
1837
+ /** Guests can only subscribe to video and audio. */
1838
+ WEBINAR = "WEBINAR"
1839
+ }
1840
+ export interface OnlineConferencingSession {
1841
+ /**
1842
+ * Link for event host to start the online conference session.
1843
+ * @readonly
1844
+ */
1845
+ hostLink?: string;
1846
+ /**
1847
+ * Link for guests to join the online conference session.
1848
+ * @readonly
1849
+ */
1850
+ guestLink?: string;
1851
+ /**
1852
+ * The password required to join online conferencing session (when relevant).
1853
+ * @readonly
1854
+ */
1855
+ password?: string | null;
1856
+ /**
1857
+ * Indicates that session was created successfully on providers side.
1858
+ * @readonly
1859
+ */
1860
+ sessionCreated?: boolean | null;
1861
+ /**
1862
+ * Unique session id
1863
+ * @readonly
1864
+ */
1865
+ sessionId?: string | null;
1866
+ }
1867
+ export interface SeoSettings {
1868
+ /**
1869
+ * URL slug
1870
+ * @maxLength 130
1871
+ */
1872
+ slug?: string;
1873
+ /** Advanced SEO data */
1874
+ advancedSeoData?: SeoSchema;
1875
+ /**
1876
+ * Hidden from SEO Site Map
1877
+ * @readonly
1878
+ */
1879
+ hidden?: boolean | null;
1880
+ }
1881
+ /**
1882
+ * 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.
1883
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
1884
+ * 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.
1885
+ */
1886
+ export interface SeoSchema {
1887
+ /** SEO tag information. */
1888
+ tags?: Tag[];
1889
+ /** SEO general settings. */
1890
+ settings?: Settings;
1891
+ }
1892
+ export interface Keyword {
1893
+ /** Keyword value. */
1894
+ term?: string;
1895
+ /** Whether the keyword is the main focus keyword. */
1896
+ isMain?: boolean;
1897
+ /**
1898
+ * The source that added the keyword terms to the SEO settings.
1899
+ * @maxLength 1000
1900
+ */
1901
+ origin?: string | null;
1902
+ }
1903
+ export interface Tag {
1904
+ /**
1905
+ * SEO tag type.
1906
+ *
1907
+ *
1908
+ * Supported values: `title`, `meta`, `script`, `link`.
1909
+ */
1910
+ type?: string;
1911
+ /**
1912
+ * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
1913
+ * For example: `{"name": "description", "content": "the description itself"}`.
1914
+ */
1915
+ props?: Record<string, any> | null;
1916
+ /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
1917
+ meta?: Record<string, any> | null;
1918
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
1919
+ children?: string;
1920
+ /** Whether the tag is a custom tag. */
1921
+ custom?: boolean;
1922
+ /** Whether the tag is disabled. */
1923
+ disabled?: boolean;
1924
+ }
1925
+ export interface Settings {
1926
+ /**
1927
+ * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
1928
+ *
1929
+ *
1930
+ * Default: `false` (Auto Redirect is enabled.)
1931
+ */
1932
+ preventAutoRedirect?: boolean;
1933
+ /**
1934
+ * User-selected keyword terms for a specific page.
1935
+ * @maxSize 5
1936
+ */
1937
+ keywords?: Keyword[];
1938
+ }
1939
+ export interface Agenda {
1940
+ /** Whether the schedule is enabled for the event. */
1941
+ enabled?: boolean;
1942
+ /**
1943
+ * Agenda page URL.
1944
+ * @readonly
1945
+ */
1946
+ pageUrl?: SiteUrl;
1947
+ }
1948
+ export interface Category {
1949
+ /**
1950
+ * Category ID.
1951
+ * @format GUID
1952
+ * @readonly
1953
+ */
1954
+ id?: string;
1955
+ /**
1956
+ * Category name.
1957
+ * @minLength 1
1958
+ * @maxLength 30
1959
+ */
1960
+ name?: string;
1961
+ /**
1962
+ * Date and time when category was created.
1963
+ * @readonly
1964
+ */
1965
+ createdDate?: Date | null;
1966
+ /**
1967
+ * The total number of draft and published events assigned to the category.
1968
+ * @readonly
1969
+ */
1970
+ counts?: CategoryCounts;
1971
+ /**
1972
+ * Category state. Possible values:
1973
+ *
1974
+ * `MANUAL`: Category is created manually by the user.
1975
+ * `AUTO`: Category is created automatically.
1976
+ * `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
1977
+ * `HIDDEN`: Category can't be seen.
1978
+ *
1979
+ * Default: `MANUAL`.
1980
+ *
1981
+ * **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
1982
+ * @maxSize 3
1983
+ */
1984
+ states?: CategoryStateState[];
1985
+ }
1986
+ export interface CategoryCounts {
1987
+ /** Total number of draft events assigned to the category. */
1988
+ assignedEventsCount?: number | null;
1989
+ /** Total number of published events assigned to the category. Deleted events are excluded. */
1990
+ assignedDraftEventsCount?: number | null;
1991
+ }
1992
+ export declare enum CategoryStateState {
1993
+ /** Created manually by the user. */
1994
+ MANUAL = "MANUAL",
1995
+ /** Created automatically. */
1996
+ AUTO = "AUTO",
1997
+ /** Created when publishing recurring events. */
1998
+ RECURRING_EVENT = "RECURRING_EVENT",
1999
+ /** Category is hidden. */
2000
+ HIDDEN = "HIDDEN"
2001
+ }
2002
+ export interface EventDisplaySettings {
2003
+ /** Whether event details button is hidden. Only available for events with no registration. */
2004
+ hideEventDetailsButton?: boolean | null;
2005
+ /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
2006
+ hideEventDetailsPage?: boolean | null;
2007
+ }
2008
+ export interface LabellingSettings {
2009
+ }
2010
+ export interface RichContent {
2011
+ /** Node objects representing a rich content document. */
2012
+ nodes?: Node[];
2013
+ /** Object metadata. */
2014
+ metadata?: Metadata;
2015
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
2016
+ documentStyle?: DocumentStyle;
2017
+ }
2018
+ export interface Node extends NodeDataOneOf {
2019
+ /** Data for a button node. */
2020
+ buttonData?: ButtonData;
2021
+ /** Data for a code block node. */
2022
+ codeBlockData?: CodeBlockData;
2023
+ /** Data for a divider node. */
2024
+ dividerData?: DividerData;
2025
+ /** Data for a file node. */
2026
+ fileData?: FileData;
2027
+ /** Data for a gallery node. */
2028
+ galleryData?: GalleryData;
2029
+ /** Data for a GIF node. */
2030
+ gifData?: GIFData;
2031
+ /** Data for a heading node. */
2032
+ headingData?: HeadingData;
2033
+ /** Data for an embedded HTML node. */
2034
+ htmlData?: HTMLData;
2035
+ /** Data for an image node. */
2036
+ imageData?: ImageData;
2037
+ /** Data for a link preview node. */
2038
+ linkPreviewData?: LinkPreviewData;
2039
+ /** @deprecated */
2040
+ mapData?: MapData;
2041
+ /** Data for a paragraph node. */
2042
+ paragraphData?: ParagraphData;
2043
+ /** Data for a poll node. */
2044
+ pollData?: PollData;
2045
+ /** Data for a text node. Used to apply decorations to text. */
2046
+ textData?: TextData;
2047
+ /** Data for an app embed node. */
2048
+ appEmbedData?: AppEmbedData;
2049
+ /** Data for a video node. */
2050
+ videoData?: VideoData;
2051
+ /** Data for an oEmbed node. */
2052
+ embedData?: EmbedData;
2053
+ /** Data for a collapsible list node. */
2054
+ collapsibleListData?: CollapsibleListData;
2055
+ /** Data for a table node. */
2056
+ tableData?: TableData;
2057
+ /** Data for a table cell node. */
2058
+ tableCellData?: TableCellData;
2059
+ /** Data for a custom external node. */
2060
+ externalData?: Record<string, any> | null;
2061
+ /** Data for an audio node. */
2062
+ audioData?: AudioData;
2063
+ /** Data for an ordered list node. */
2064
+ orderedListData?: OrderedListData;
2065
+ /** Data for a bulleted list node. */
2066
+ bulletedListData?: BulletedListData;
2067
+ /** Data for a block quote node. */
2068
+ blockquoteData?: BlockquoteData;
2069
+ /** Data for a caption node. */
2070
+ captionData?: CaptionData;
2071
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
2072
+ layoutCellData?: LayoutCellData;
2073
+ /** 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. */
2074
+ type?: NodeType;
2075
+ /** Node ID. */
2076
+ id?: string;
2077
+ /** A list of child nodes. */
2078
+ nodes?: Node[];
2079
+ /** Padding and background color styling for the node. */
2080
+ style?: NodeStyle;
2081
+ }
2082
+ /** @oneof */
2083
+ export interface NodeDataOneOf {
2084
+ /** Data for a button node. */
2085
+ buttonData?: ButtonData;
2086
+ /** Data for a code block node. */
2087
+ codeBlockData?: CodeBlockData;
2088
+ /** Data for a divider node. */
2089
+ dividerData?: DividerData;
2090
+ /** Data for a file node. */
2091
+ fileData?: FileData;
2092
+ /** Data for a gallery node. */
2093
+ galleryData?: GalleryData;
2094
+ /** Data for a GIF node. */
2095
+ gifData?: GIFData;
2096
+ /** Data for a heading node. */
2097
+ headingData?: HeadingData;
2098
+ /** Data for an embedded HTML node. */
2099
+ htmlData?: HTMLData;
2100
+ /** Data for an image node. */
2101
+ imageData?: ImageData;
2102
+ /** Data for a link preview node. */
2103
+ linkPreviewData?: LinkPreviewData;
2104
+ /** @deprecated */
2105
+ mapData?: MapData;
2106
+ /** Data for a paragraph node. */
2107
+ paragraphData?: ParagraphData;
2108
+ /** Data for a poll node. */
2109
+ pollData?: PollData;
2110
+ /** Data for a text node. Used to apply decorations to text. */
2111
+ textData?: TextData;
2112
+ /** Data for an app embed node. */
2113
+ appEmbedData?: AppEmbedData;
2114
+ /** Data for a video node. */
2115
+ videoData?: VideoData;
2116
+ /** Data for an oEmbed node. */
2117
+ embedData?: EmbedData;
2118
+ /** Data for a collapsible list node. */
2119
+ collapsibleListData?: CollapsibleListData;
2120
+ /** Data for a table node. */
2121
+ tableData?: TableData;
2122
+ /** Data for a table cell node. */
2123
+ tableCellData?: TableCellData;
2124
+ /** Data for a custom external node. */
2125
+ externalData?: Record<string, any> | null;
2126
+ /** Data for an audio node. */
2127
+ audioData?: AudioData;
2128
+ /** Data for an ordered list node. */
2129
+ orderedListData?: OrderedListData;
2130
+ /** Data for a bulleted list node. */
2131
+ bulletedListData?: BulletedListData;
2132
+ /** Data for a block quote node. */
2133
+ blockquoteData?: BlockquoteData;
2134
+ /** Data for a caption node. */
2135
+ captionData?: CaptionData;
2136
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
2137
+ layoutCellData?: LayoutCellData;
2138
+ }
2139
+ export declare enum NodeType {
2140
+ PARAGRAPH = "PARAGRAPH",
2141
+ TEXT = "TEXT",
2142
+ HEADING = "HEADING",
2143
+ BULLETED_LIST = "BULLETED_LIST",
2144
+ ORDERED_LIST = "ORDERED_LIST",
2145
+ LIST_ITEM = "LIST_ITEM",
2146
+ BLOCKQUOTE = "BLOCKQUOTE",
2147
+ CODE_BLOCK = "CODE_BLOCK",
2148
+ VIDEO = "VIDEO",
2149
+ DIVIDER = "DIVIDER",
2150
+ FILE = "FILE",
2151
+ GALLERY = "GALLERY",
2152
+ GIF = "GIF",
2153
+ HTML = "HTML",
2154
+ IMAGE = "IMAGE",
2155
+ LINK_PREVIEW = "LINK_PREVIEW",
2156
+ /** @deprecated */
2157
+ MAP = "MAP",
2158
+ POLL = "POLL",
2159
+ APP_EMBED = "APP_EMBED",
2160
+ BUTTON = "BUTTON",
2161
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
2162
+ TABLE = "TABLE",
2163
+ EMBED = "EMBED",
2164
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
2165
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
2166
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
2167
+ TABLE_CELL = "TABLE_CELL",
2168
+ TABLE_ROW = "TABLE_ROW",
2169
+ EXTERNAL = "EXTERNAL",
2170
+ AUDIO = "AUDIO",
2171
+ CAPTION = "CAPTION",
2172
+ LAYOUT = "LAYOUT",
2173
+ LAYOUT_CELL = "LAYOUT_CELL"
2174
+ }
2175
+ export interface NodeStyle {
2176
+ /** The top padding value in pixels. */
2177
+ paddingTop?: string | null;
2178
+ /** The bottom padding value in pixels. */
2179
+ paddingBottom?: string | null;
2180
+ /** The background color as a hexadecimal value. */
2181
+ backgroundColor?: string | null;
2182
+ }
2183
+ export interface ButtonData {
2184
+ /** Styling for the button's container. */
2185
+ containerData?: PluginContainerData;
2186
+ /** The button type. */
2187
+ type?: ButtonDataType;
2188
+ /** Styling for the button. */
2189
+ styles?: Styles;
2190
+ /** The text to display on the button. */
2191
+ text?: string | null;
2192
+ /** Button link details. */
2193
+ link?: Link;
2194
+ }
2195
+ export interface Border {
2196
+ /** Border width in pixels. */
2197
+ width?: number | null;
2198
+ /** Border radius in pixels. */
2199
+ radius?: number | null;
2200
+ }
2201
+ export interface Colors {
2202
+ /** The text color as a hexadecimal value. */
2203
+ text?: string | null;
2204
+ /** The border color as a hexadecimal value. */
2205
+ border?: string | null;
2206
+ /** The background color as a hexadecimal value. */
2207
+ background?: string | null;
2208
+ }
2209
+ export interface PluginContainerData {
2210
+ /** The width of the node when it's displayed. */
2211
+ width?: PluginContainerDataWidth;
2212
+ /** The node's alignment within its container. */
2213
+ alignment?: PluginContainerDataAlignment;
2214
+ /** Spoiler cover settings for the node. */
2215
+ spoiler?: Spoiler;
2216
+ /** The height of the node when it's displayed. */
2217
+ height?: Height;
2218
+ /** 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`. */
2219
+ textWrap?: boolean | null;
2220
+ }
2221
+ export declare enum WidthType {
2222
+ /** Width matches the content width */
2223
+ CONTENT = "CONTENT",
2224
+ /** Small Width */
2225
+ SMALL = "SMALL",
2226
+ /** Width will match the original asset width */
2227
+ ORIGINAL = "ORIGINAL",
2228
+ /** coast-to-coast display */
2229
+ FULL_WIDTH = "FULL_WIDTH"
2230
+ }
2231
+ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
2232
+ /**
2233
+ * One of the following predefined width options:
2234
+ * `CONTENT`: The width of the container matches the content width.
2235
+ * `SMALL`: A small width.
2236
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
2237
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
2238
+ */
2239
+ size?: WidthType;
2240
+ /** A custom width value in pixels. */
2241
+ custom?: string | null;
2242
+ }
2243
+ /** @oneof */
2244
+ export interface PluginContainerDataWidthDataOneOf {
2245
+ /**
2246
+ * One of the following predefined width options:
2247
+ * `CONTENT`: The width of the container matches the content width.
2248
+ * `SMALL`: A small width.
2249
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
2250
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
2251
+ */
2252
+ size?: WidthType;
2253
+ /** A custom width value in pixels. */
2254
+ custom?: string | null;
2255
+ }
2256
+ export declare enum PluginContainerDataAlignment {
2257
+ /** Center Alignment */
2258
+ CENTER = "CENTER",
2259
+ /** Left Alignment */
2260
+ LEFT = "LEFT",
2261
+ /** Right Alignment */
2262
+ RIGHT = "RIGHT"
2263
+ }
2264
+ export interface Spoiler {
2265
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
2266
+ enabled?: boolean | null;
2267
+ /** The description displayed on top of the spoiler cover. */
2268
+ description?: string | null;
2269
+ /** The text for the button used to remove the spoiler cover. */
2270
+ buttonText?: string | null;
2271
+ }
2272
+ export interface Height {
2273
+ /** A custom height value in pixels. */
2274
+ custom?: string | null;
2275
+ }
2276
+ export declare enum ButtonDataType {
2277
+ /** Regular link button */
2278
+ LINK = "LINK",
2279
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
2280
+ ACTION = "ACTION"
2281
+ }
2282
+ export interface Styles {
2283
+ /** Border attributes. */
2284
+ border?: Border;
2285
+ /** Color attributes. */
2286
+ colors?: Colors;
2287
+ }
2288
+ export interface Link extends LinkDataOneOf {
2289
+ /** The absolute URL for the linked document. */
2290
+ url?: string;
2291
+ /** The target node's ID. Used for linking to another node in this object. */
2292
+ anchor?: string;
2293
+ /**
2294
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
2295
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
2296
+ * `BLANK` - Opens the linked document in a new browser tab or window.
2297
+ * `PARENT` - Opens the linked document in the link's parent frame.
2298
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
2299
+ */
2300
+ target?: Target;
2301
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
2302
+ rel?: Rel;
2303
+ /** A serialized object used for a custom or external link panel. */
2304
+ customData?: string | null;
2305
+ }
2306
+ /** @oneof */
2307
+ export interface LinkDataOneOf {
2308
+ /** The absolute URL for the linked document. */
2309
+ url?: string;
2310
+ /** The target node's ID. Used for linking to another node in this object. */
2311
+ anchor?: string;
2312
+ }
2313
+ export declare enum Target {
2314
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
2315
+ SELF = "SELF",
2316
+ /** Opens the linked document in a new window or tab */
2317
+ BLANK = "BLANK",
2318
+ /** Opens the linked document in the parent frame */
2319
+ PARENT = "PARENT",
2320
+ /** Opens the linked document in the full body of the window */
2321
+ TOP = "TOP"
2322
+ }
2323
+ export interface Rel {
2324
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
2325
+ nofollow?: boolean | null;
2326
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
2327
+ sponsored?: boolean | null;
2328
+ /** 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`. */
2329
+ ugc?: boolean | null;
2330
+ /** Indicates that this link protect referral information from being passed to the target website. */
2331
+ noreferrer?: boolean | null;
2332
+ }
2333
+ export interface CodeBlockData {
2334
+ /** Styling for the code block's text. */
2335
+ textStyle?: TextStyle;
2336
+ }
2337
+ export interface TextStyle {
2338
+ /** Text alignment. Defaults to `AUTO`. */
2339
+ textAlignment?: TextAlignment;
2340
+ /** 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. */
2341
+ lineHeight?: string | null;
2342
+ }
2343
+ export declare enum TextAlignment {
2344
+ /** browser default, eqivalent to `initial` */
2345
+ AUTO = "AUTO",
2346
+ /** Left align */
2347
+ LEFT = "LEFT",
2348
+ /** Right align */
2349
+ RIGHT = "RIGHT",
2350
+ /** Center align */
2351
+ CENTER = "CENTER",
2352
+ /** 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 */
2353
+ JUSTIFY = "JUSTIFY"
2354
+ }
2355
+ export interface DividerData {
2356
+ /** Styling for the divider's container. */
2357
+ containerData?: PluginContainerData;
2358
+ /** Divider line style. */
2359
+ lineStyle?: LineStyle;
2360
+ /** Divider width. */
2361
+ width?: Width;
2362
+ /** Divider alignment. */
2363
+ alignment?: Alignment;
2364
+ }
2365
+ export declare enum LineStyle {
2366
+ /** Single Line */
2367
+ SINGLE = "SINGLE",
2368
+ /** Double Line */
2369
+ DOUBLE = "DOUBLE",
2370
+ /** Dashed Line */
2371
+ DASHED = "DASHED",
2372
+ /** Dotted Line */
2373
+ DOTTED = "DOTTED"
2374
+ }
2375
+ export declare enum Width {
2376
+ /** Large line */
2377
+ LARGE = "LARGE",
2378
+ /** Medium line */
2379
+ MEDIUM = "MEDIUM",
2380
+ /** Small line */
2381
+ SMALL = "SMALL"
2382
+ }
2383
+ export declare enum Alignment {
2384
+ /** Center alignment */
2385
+ CENTER = "CENTER",
2386
+ /** Left alignment */
2387
+ LEFT = "LEFT",
2388
+ /** Right alignment */
2389
+ RIGHT = "RIGHT"
2390
+ }
2391
+ export interface FileData {
2392
+ /** Styling for the file's container. */
2393
+ containerData?: PluginContainerData;
2394
+ /** The source for the file's data. */
2395
+ src?: FileSource;
2396
+ /** File name. */
2397
+ name?: string | null;
2398
+ /** File type. */
2399
+ type?: string | null;
2400
+ /**
2401
+ * Use `sizeInKb` instead.
2402
+ * @deprecated
2403
+ */
2404
+ size?: number | null;
2405
+ /** Settings for PDF files. */
2406
+ pdfSettings?: PDFSettings;
2407
+ /** File MIME type. */
2408
+ mimeType?: string | null;
2409
+ /** File path. */
2410
+ path?: string | null;
2411
+ /** File size in KB. */
2412
+ sizeInKb?: string | null;
2413
+ }
2414
+ export declare enum ViewMode {
2415
+ /** No PDF view */
2416
+ NONE = "NONE",
2417
+ /** Full PDF view */
2418
+ FULL = "FULL",
2419
+ /** Mini PDF view */
2420
+ MINI = "MINI"
2421
+ }
2422
+ export interface FileSource extends FileSourceDataOneOf {
2423
+ /** The absolute URL for the file's source. */
2424
+ url?: string | null;
2425
+ /**
2426
+ * Custom ID. Use `id` instead.
2427
+ * @deprecated
2428
+ */
2429
+ custom?: string | null;
2430
+ /** An ID that's resolved to a URL by a resolver function. */
2431
+ id?: string | null;
2432
+ /** Indicates whether the file's source is private. Defaults to `false`. */
2433
+ private?: boolean | null;
2434
+ }
2435
+ /** @oneof */
2436
+ export interface FileSourceDataOneOf {
2437
+ /** The absolute URL for the file's source. */
2438
+ url?: string | null;
2439
+ /**
2440
+ * Custom ID. Use `id` instead.
2441
+ * @deprecated
2442
+ */
2443
+ custom?: string | null;
2444
+ /** An ID that's resolved to a URL by a resolver function. */
2445
+ id?: string | null;
2446
+ }
2447
+ export interface PDFSettings {
2448
+ /**
2449
+ * PDF view mode. One of the following:
2450
+ * `NONE` : The PDF isn't displayed.
2451
+ * `FULL` : A full page view of the PDF is displayed.
2452
+ * `MINI` : A mini view of the PDF is displayed.
2453
+ */
2454
+ viewMode?: ViewMode;
2455
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
2456
+ disableDownload?: boolean | null;
2457
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
2458
+ disablePrint?: boolean | null;
2459
+ }
2460
+ export interface GalleryData {
2461
+ /** Styling for the gallery's container. */
2462
+ containerData?: PluginContainerData;
2463
+ /** The items in the gallery. */
2464
+ items?: Item[];
2465
+ /** Options for defining the gallery's appearance. */
2466
+ options?: GalleryOptions;
2467
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
2468
+ disableExpand?: boolean | null;
2469
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
2470
+ disableDownload?: boolean | null;
2471
+ }
2472
+ export interface Media {
2473
+ /** The source for the media's data. */
2474
+ src?: FileSource;
2475
+ /** Media width in pixels. */
2476
+ width?: number | null;
2477
+ /** Media height in pixels. */
2478
+ height?: number | null;
2479
+ /** Media duration in seconds. Only relevant for audio and video files. */
2480
+ duration?: number | null;
2481
+ }
2482
+ export interface ItemImage {
2483
+ /** Image file details. */
2484
+ media?: Media;
2485
+ /** Link details for images that are links. */
2486
+ link?: Link;
2487
+ }
2488
+ export interface Video {
2489
+ /** Video file details. */
2490
+ media?: Media;
2491
+ /** Video thumbnail file details. */
2492
+ thumbnail?: Media;
2493
+ }
2494
+ export interface Item extends ItemDataOneOf {
2495
+ /** An image item. */
2496
+ image?: ItemImage;
2497
+ /** A video item. */
2498
+ video?: Video;
2499
+ /** Item title. */
2500
+ title?: string | null;
2501
+ /** Item's alternative text. */
2502
+ altText?: string | null;
2503
+ }
2504
+ /** @oneof */
2505
+ export interface ItemDataOneOf {
2506
+ /** An image item. */
2507
+ image?: ItemImage;
2508
+ /** A video item. */
2509
+ video?: Video;
2510
+ }
2511
+ export interface GalleryOptions {
2512
+ /** Gallery layout. */
2513
+ layout?: Layout;
2514
+ /** Styling for gallery items. */
2515
+ item?: ItemStyle;
2516
+ /** Styling for gallery thumbnail images. */
2517
+ thumbnails?: Thumbnails;
2518
+ }
2519
+ export declare enum LayoutType {
2520
+ /** Collage type */
2521
+ COLLAGE = "COLLAGE",
2522
+ /** Masonry type */
2523
+ MASONRY = "MASONRY",
2524
+ /** Grid type */
2525
+ GRID = "GRID",
2526
+ /** Thumbnail type */
2527
+ THUMBNAIL = "THUMBNAIL",
2528
+ /** Slider type */
2529
+ SLIDER = "SLIDER",
2530
+ /** Slideshow type */
2531
+ SLIDESHOW = "SLIDESHOW",
2532
+ /** Panorama type */
2533
+ PANORAMA = "PANORAMA",
2534
+ /** Column type */
2535
+ COLUMN = "COLUMN",
2536
+ /** Magic type */
2537
+ MAGIC = "MAGIC",
2538
+ /** Fullsize images type */
2539
+ FULLSIZE = "FULLSIZE"
2540
+ }
2541
+ export declare enum Orientation {
2542
+ /** Rows Orientation */
2543
+ ROWS = "ROWS",
2544
+ /** Columns Orientation */
2545
+ COLUMNS = "COLUMNS"
2546
+ }
2547
+ export declare enum Crop {
2548
+ /** Crop to fill */
2549
+ FILL = "FILL",
2550
+ /** Crop to fit */
2551
+ FIT = "FIT"
2552
+ }
2553
+ export declare enum ThumbnailsAlignment {
2554
+ /** Top alignment */
2555
+ TOP = "TOP",
2556
+ /** Right alignment */
2557
+ RIGHT = "RIGHT",
2558
+ /** Bottom alignment */
2559
+ BOTTOM = "BOTTOM",
2560
+ /** Left alignment */
2561
+ LEFT = "LEFT",
2562
+ /** No thumbnail */
2563
+ NONE = "NONE"
2564
+ }
2565
+ export interface Layout {
2566
+ /** Gallery layout type. */
2567
+ type?: LayoutType;
2568
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
2569
+ horizontalScroll?: boolean | null;
2570
+ /** Gallery orientation. */
2571
+ orientation?: Orientation;
2572
+ /** The number of columns to display on full size screens. */
2573
+ numberOfColumns?: number | null;
2574
+ /** The number of columns to display on mobile screens. */
2575
+ mobileNumberOfColumns?: number | null;
2576
+ }
2577
+ export interface ItemStyle {
2578
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
2579
+ targetSize?: number | null;
2580
+ /** Item ratio */
2581
+ ratio?: number | null;
2582
+ /** Sets how item images are cropped. */
2583
+ crop?: Crop;
2584
+ /** The spacing between items in pixels. */
2585
+ spacing?: number | null;
2586
+ }
2587
+ export interface Thumbnails {
2588
+ /** Thumbnail alignment. */
2589
+ placement?: ThumbnailsAlignment;
2590
+ /** Spacing between thumbnails in pixels. */
2591
+ spacing?: number | null;
2592
+ }
2593
+ export interface GIFData {
2594
+ /** Styling for the GIF's container. */
2595
+ containerData?: PluginContainerData;
2596
+ /** The source of the full size GIF. */
2597
+ original?: GIF;
2598
+ /** The source of the downsized GIF. */
2599
+ downsized?: GIF;
2600
+ /** Height in pixels. */
2601
+ height?: number;
2602
+ /** Width in pixels. */
2603
+ width?: number;
2604
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2605
+ gifType?: GIFType;
2606
+ }
2607
+ export interface GIF {
2608
+ /**
2609
+ * GIF format URL.
2610
+ * @format WEB_URL
2611
+ */
2612
+ gif?: string | null;
2613
+ /**
2614
+ * MP4 format URL.
2615
+ * @format WEB_URL
2616
+ */
2617
+ mp4?: string | null;
2618
+ /**
2619
+ * Thumbnail URL.
2620
+ * @format WEB_URL
2621
+ */
2622
+ still?: string | null;
2623
+ }
2624
+ export declare enum GIFType {
2625
+ NORMAL = "NORMAL",
2626
+ STICKER = "STICKER"
2627
+ }
2628
+ export interface HeadingData {
2629
+ /** Heading level from 1-6. */
2630
+ level?: number;
2631
+ /** Styling for the heading text. */
2632
+ textStyle?: TextStyle;
2633
+ /** Indentation level from 1-4. */
2634
+ indentation?: number | null;
2635
+ }
2636
+ export interface HTMLData extends HTMLDataDataOneOf {
2637
+ /** The URL for the HTML code for the node. */
2638
+ url?: string;
2639
+ /** The HTML code for the node. */
2640
+ html?: string;
2641
+ /**
2642
+ * Whether this is an AdSense element. Use `source` instead.
2643
+ * @deprecated
2644
+ */
2645
+ isAdsense?: boolean | null;
2646
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2647
+ containerData?: PluginContainerData;
2648
+ /** The type of HTML code. */
2649
+ source?: Source;
2650
+ /** If container height is aligned with its content height. Defaults to `true`. */
2651
+ autoHeight?: boolean | null;
2652
+ }
2653
+ /** @oneof */
2654
+ export interface HTMLDataDataOneOf {
2655
+ /** The URL for the HTML code for the node. */
2656
+ url?: string;
2657
+ /** The HTML code for the node. */
2658
+ html?: string;
2659
+ /**
2660
+ * Whether this is an AdSense element. Use `source` instead.
2661
+ * @deprecated
2662
+ */
2663
+ isAdsense?: boolean | null;
2664
+ }
2665
+ export declare enum Source {
2666
+ HTML = "HTML",
2667
+ ADSENSE = "ADSENSE"
2668
+ }
2669
+ export interface ImageData {
2670
+ /** Styling for the image's container. */
2671
+ containerData?: PluginContainerData;
2672
+ /** Image file details. */
2673
+ image?: Media;
2674
+ /** Link details for images that are links. */
2675
+ link?: Link;
2676
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
2677
+ disableExpand?: boolean | null;
2678
+ /** Image's alternative text. */
2679
+ altText?: string | null;
2680
+ /**
2681
+ * Deprecated: use Caption node instead.
2682
+ * @deprecated
2683
+ */
2684
+ caption?: string | null;
2685
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
2686
+ disableDownload?: boolean | null;
2687
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
2688
+ decorative?: boolean | null;
2689
+ /** Styling for the image. */
2690
+ styles?: ImageDataStyles;
2691
+ }
2692
+ export interface StylesBorder {
2693
+ /** Border width in pixels. */
2694
+ width?: number | null;
2695
+ /**
2696
+ * Border color as a hexadecimal value.
2697
+ * @format COLOR_HEX
2698
+ */
2699
+ color?: string | null;
2700
+ /** Border radius in pixels. */
2701
+ radius?: number | null;
2702
+ }
2703
+ export interface ImageDataStyles {
2704
+ /** Border attributes. */
2705
+ border?: StylesBorder;
2706
+ }
2707
+ export interface LinkPreviewData {
2708
+ /** Styling for the link preview's container. */
2709
+ containerData?: PluginContainerData;
2710
+ /** Link details. */
2711
+ link?: Link;
2712
+ /** Preview title. */
2713
+ title?: string | null;
2714
+ /** Preview thumbnail URL. */
2715
+ thumbnailUrl?: string | null;
2716
+ /** Preview description. */
2717
+ description?: string | null;
2718
+ /** The preview content as HTML. */
2719
+ html?: string | null;
2720
+ /** Styling for the link preview. */
2721
+ styles?: LinkPreviewDataStyles;
2722
+ }
2723
+ export declare enum Position {
2724
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2725
+ START = "START",
2726
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
2727
+ END = "END",
2728
+ /** Thumbnail positioned at the top */
2729
+ TOP = "TOP",
2730
+ /** Thumbnail hidden and not displayed */
2731
+ HIDDEN = "HIDDEN"
2732
+ }
2733
+ export interface LinkPreviewDataStyles {
2734
+ /**
2735
+ * Background color as a hexadecimal value.
2736
+ * @format COLOR_HEX
2737
+ */
2738
+ backgroundColor?: string | null;
2739
+ /**
2740
+ * Title color as a hexadecimal value.
2741
+ * @format COLOR_HEX
2742
+ */
2743
+ titleColor?: string | null;
2744
+ /**
2745
+ * Subtitle color as a hexadecimal value.
2746
+ * @format COLOR_HEX
2747
+ */
2748
+ subtitleColor?: string | null;
2749
+ /**
2750
+ * Link color as a hexadecimal value.
2751
+ * @format COLOR_HEX
2752
+ */
2753
+ linkColor?: string | null;
2754
+ /** Border width in pixels. */
2755
+ borderWidth?: number | null;
2756
+ /** Border radius in pixels. */
2757
+ borderRadius?: number | null;
2758
+ /**
2759
+ * Border color as a hexadecimal value.
2760
+ * @format COLOR_HEX
2761
+ */
2762
+ borderColor?: string | null;
2763
+ /** Position of thumbnail. Defaults to `START`. */
2764
+ thumbnailPosition?: Position;
2765
+ }
2766
+ export interface MapData {
2767
+ /** Styling for the map's container. */
2768
+ containerData?: PluginContainerData;
2769
+ /** Map settings. */
2770
+ mapSettings?: MapSettings;
2771
+ }
2772
+ export interface MapSettings {
2773
+ /** The address to display on the map. */
2774
+ address?: string | null;
2775
+ /** Sets whether the map is draggable. */
2776
+ draggable?: boolean | null;
2777
+ /** Sets whether the location marker is visible. */
2778
+ marker?: boolean | null;
2779
+ /** Sets whether street view control is enabled. */
2780
+ streetViewControl?: boolean | null;
2781
+ /** Sets whether zoom control is enabled. */
2782
+ zoomControl?: boolean | null;
2783
+ /** Location latitude. */
2784
+ lat?: number | null;
2785
+ /** Location longitude. */
2786
+ lng?: number | null;
2787
+ /** Location name. */
2788
+ locationName?: string | null;
2789
+ /** Sets whether view mode control is enabled. */
2790
+ viewModeControl?: boolean | null;
2791
+ /** Initial zoom value. */
2792
+ initialZoom?: number | null;
2793
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2794
+ mapType?: MapType;
2795
+ }
2796
+ export declare enum MapType {
2797
+ /** Roadmap map type */
2798
+ ROADMAP = "ROADMAP",
2799
+ /** Satellite map type */
2800
+ SATELITE = "SATELITE",
2801
+ /** Hybrid map type */
2802
+ HYBRID = "HYBRID",
2803
+ /** Terrain map type */
2804
+ TERRAIN = "TERRAIN"
2805
+ }
2806
+ export interface ParagraphData {
2807
+ /** Styling for the paragraph text. */
2808
+ textStyle?: TextStyle;
2809
+ /** Indentation level from 1-4. */
2810
+ indentation?: number | null;
2811
+ /** Paragraph level */
2812
+ level?: number | null;
2813
+ }
2814
+ export interface PollData {
2815
+ /** Styling for the poll's container. */
2816
+ containerData?: PluginContainerData;
2817
+ /** Poll data. */
2818
+ poll?: Poll;
2819
+ /** Layout settings for the poll and voting options. */
2820
+ layout?: PollDataLayout;
2821
+ /** Styling for the poll and voting options. */
2822
+ design?: Design;
2823
+ }
2824
+ export declare enum ViewRole {
2825
+ /** Only Poll creator can view the results */
2826
+ CREATOR = "CREATOR",
2827
+ /** Anyone who voted can see the results */
2828
+ VOTERS = "VOTERS",
2829
+ /** Anyone can see the results, even if one didn't vote */
2830
+ EVERYONE = "EVERYONE"
2831
+ }
2832
+ export declare enum VoteRole {
2833
+ /** Logged in member */
2834
+ SITE_MEMBERS = "SITE_MEMBERS",
2835
+ /** Anyone */
2836
+ ALL = "ALL"
2837
+ }
2838
+ export interface Permissions {
2839
+ /** Sets who can view the poll results. */
2840
+ view?: ViewRole;
2841
+ /** Sets who can vote. */
2842
+ vote?: VoteRole;
2843
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2844
+ allowMultipleVotes?: boolean | null;
2845
+ }
2846
+ export interface Option {
2847
+ /** Option ID. */
2848
+ id?: string | null;
2849
+ /** Option title. */
2850
+ title?: string | null;
2851
+ /** The image displayed with the option. */
2852
+ image?: Media;
2853
+ }
2854
+ export interface PollSettings {
2855
+ /** Permissions settings for voting. */
2856
+ permissions?: Permissions;
2857
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
2858
+ showVoters?: boolean | null;
2859
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
2860
+ showVotesCount?: boolean | null;
2861
+ }
2862
+ export declare enum PollLayoutType {
2863
+ /** List */
2864
+ LIST = "LIST",
2865
+ /** Grid */
2866
+ GRID = "GRID"
2867
+ }
2868
+ export declare enum PollLayoutDirection {
2869
+ /** Left-to-right */
2870
+ LTR = "LTR",
2871
+ /** Right-to-left */
2872
+ RTL = "RTL"
2873
+ }
2874
+ export interface PollLayout {
2875
+ /** The layout for displaying the voting options. */
2876
+ type?: PollLayoutType;
2877
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2878
+ direction?: PollLayoutDirection;
2879
+ /** Sets whether to display the main poll image. Defaults to `false`. */
2880
+ enableImage?: boolean | null;
2881
+ }
2882
+ export interface OptionLayout {
2883
+ /** Sets whether to display option images. Defaults to `false`. */
2884
+ enableImage?: boolean | null;
2885
+ }
2886
+ export declare enum BackgroundType {
2887
+ /** Color background type */
2888
+ COLOR = "COLOR",
2889
+ /** Image background type */
2890
+ IMAGE = "IMAGE",
2891
+ /** Gradiant background type */
2892
+ GRADIENT = "GRADIENT"
2893
+ }
2894
+ export interface Gradient {
2895
+ /** The gradient angle in degrees. */
2896
+ angle?: number | null;
2897
+ /**
2898
+ * The start color as a hexademical value.
2899
+ * @format COLOR_HEX
2900
+ */
2901
+ startColor?: string | null;
2902
+ /**
2903
+ * The end color as a hexademical value.
2904
+ * @format COLOR_HEX
2905
+ */
2906
+ lastColor?: string | null;
2907
+ }
2908
+ export interface Background extends BackgroundBackgroundOneOf {
2909
+ /**
2910
+ * The background color as a hexademical value.
2911
+ * @format COLOR_HEX
2912
+ */
2913
+ color?: string | null;
2914
+ /** An image to use for the background. */
2915
+ image?: Media;
2916
+ /** Details for a gradient background. */
2917
+ gradient?: Gradient;
2918
+ /** Background type. For each option, include the relevant details. */
2919
+ type?: BackgroundType;
2920
+ }
2921
+ /** @oneof */
2922
+ export interface BackgroundBackgroundOneOf {
2923
+ /**
2924
+ * The background color as a hexademical value.
2925
+ * @format COLOR_HEX
2926
+ */
2927
+ color?: string | null;
2928
+ /** An image to use for the background. */
2929
+ image?: Media;
2930
+ /** Details for a gradient background. */
2931
+ gradient?: Gradient;
2932
+ }
2933
+ export interface PollDesign {
2934
+ /** Background styling. */
2935
+ background?: Background;
2936
+ /** Border radius in pixels. */
2937
+ borderRadius?: number | null;
2938
+ }
2939
+ export interface OptionDesign {
2940
+ /** Border radius in pixels. */
2941
+ borderRadius?: number | null;
2942
+ }
2943
+ export interface Poll {
2944
+ /** Poll ID. */
2945
+ id?: string | null;
2946
+ /** Poll title. */
2947
+ title?: string | null;
2948
+ /** Poll creator ID. */
2949
+ creatorId?: string | null;
2950
+ /** Main poll image. */
2951
+ image?: Media;
2952
+ /** Voting options. */
2953
+ options?: Option[];
2954
+ /** The poll's permissions and display settings. */
2955
+ settings?: PollSettings;
2956
+ }
2957
+ export interface PollDataLayout {
2958
+ /** Poll layout settings. */
2959
+ poll?: PollLayout;
2960
+ /** Voting otpions layout settings. */
2961
+ options?: OptionLayout;
2962
+ }
2963
+ export interface Design {
2964
+ /** Styling for the poll. */
2965
+ poll?: PollDesign;
2966
+ /** Styling for voting options. */
2967
+ options?: OptionDesign;
2968
+ }
2969
+ export interface TextData {
2970
+ /** The text to apply decorations to. */
2971
+ text?: string;
2972
+ /** The decorations to apply. */
2973
+ decorations?: Decoration[];
2974
+ }
2975
+ /** Adds appearence changes to text */
2976
+ export interface Decoration extends DecorationDataOneOf {
2977
+ /** Data for an anchor link decoration. */
2978
+ anchorData?: AnchorData;
2979
+ /** Data for a color decoration. */
2980
+ colorData?: ColorData;
2981
+ /** Data for an external link decoration. */
2982
+ linkData?: LinkData;
2983
+ /** Data for a mention decoration. */
2984
+ mentionData?: MentionData;
2985
+ /** Data for a font size decoration. */
2986
+ fontSizeData?: FontSizeData;
2987
+ /** Font weight for a bold decoration. */
2988
+ fontWeightValue?: number | null;
2989
+ /** Data for an italic decoration. Defaults to `true`. */
2990
+ italicData?: boolean | null;
2991
+ /** Data for an underline decoration. Defaults to `true`. */
2992
+ underlineData?: boolean | null;
2993
+ /** Data for a spoiler decoration. */
2994
+ spoilerData?: SpoilerData;
2995
+ /** The type of decoration to apply. */
2996
+ type?: DecorationType;
2997
+ }
2998
+ /** @oneof */
2999
+ export interface DecorationDataOneOf {
3000
+ /** Data for an anchor link decoration. */
3001
+ anchorData?: AnchorData;
3002
+ /** Data for a color decoration. */
3003
+ colorData?: ColorData;
3004
+ /** Data for an external link decoration. */
3005
+ linkData?: LinkData;
3006
+ /** Data for a mention decoration. */
3007
+ mentionData?: MentionData;
3008
+ /** Data for a font size decoration. */
3009
+ fontSizeData?: FontSizeData;
3010
+ /** Font weight for a bold decoration. */
3011
+ fontWeightValue?: number | null;
3012
+ /** Data for an italic decoration. Defaults to `true`. */
3013
+ italicData?: boolean | null;
3014
+ /** Data for an underline decoration. Defaults to `true`. */
3015
+ underlineData?: boolean | null;
3016
+ /** Data for a spoiler decoration. */
3017
+ spoilerData?: SpoilerData;
3018
+ }
3019
+ export declare enum DecorationType {
3020
+ BOLD = "BOLD",
3021
+ ITALIC = "ITALIC",
3022
+ UNDERLINE = "UNDERLINE",
3023
+ SPOILER = "SPOILER",
3024
+ ANCHOR = "ANCHOR",
3025
+ MENTION = "MENTION",
3026
+ LINK = "LINK",
3027
+ COLOR = "COLOR",
3028
+ FONT_SIZE = "FONT_SIZE",
3029
+ EXTERNAL = "EXTERNAL"
3030
+ }
3031
+ export interface AnchorData {
3032
+ /** The target node's ID. */
3033
+ anchor?: string;
3034
+ }
3035
+ export interface ColorData {
3036
+ /** The text's background color as a hexadecimal value. */
3037
+ background?: string | null;
3038
+ /** The text's foreground color as a hexadecimal value. */
3039
+ foreground?: string | null;
3040
+ }
3041
+ export interface LinkData {
3042
+ /** Link details. */
3043
+ link?: Link;
3044
+ }
3045
+ export interface MentionData {
3046
+ /** The mentioned user's name. */
3047
+ name?: string;
3048
+ /** The version of the user's name that appears after the `@` character in the mention. */
3049
+ slug?: string;
3050
+ /** Mentioned user's ID. */
3051
+ id?: string | null;
3052
+ }
3053
+ export interface FontSizeData {
3054
+ /** The units used for the font size. */
3055
+ unit?: FontType;
3056
+ /** Font size value. */
3057
+ value?: number | null;
3058
+ }
3059
+ export declare enum FontType {
3060
+ PX = "PX",
3061
+ EM = "EM"
3062
+ }
3063
+ export interface SpoilerData {
3064
+ /** Spoiler ID. */
3065
+ id?: string | null;
3066
+ }
3067
+ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
3068
+ /** Data for embedded Wix Bookings content. */
3069
+ bookingData?: BookingData;
3070
+ /** Data for embedded Wix Events content. */
3071
+ eventData?: EventData;
3072
+ /** The type of Wix App content being embedded. */
3073
+ type?: AppType;
3074
+ /** The ID of the embedded content. */
3075
+ itemId?: string | null;
3076
+ /** The name of the embedded content. */
3077
+ name?: string | null;
3078
+ /**
3079
+ * Deprecated: Use `image` instead.
3080
+ * @deprecated
3081
+ */
3082
+ imageSrc?: string | null;
3083
+ /** The URL for the embedded content. */
3084
+ url?: string | null;
3085
+ /** An image for the embedded content. */
3086
+ image?: Media;
3087
+ }
3088
+ /** @oneof */
3089
+ export interface AppEmbedDataAppDataOneOf {
3090
+ /** Data for embedded Wix Bookings content. */
3091
+ bookingData?: BookingData;
3092
+ /** Data for embedded Wix Events content. */
3093
+ eventData?: EventData;
3094
+ }
3095
+ export declare enum AppType {
3096
+ PRODUCT = "PRODUCT",
3097
+ EVENT = "EVENT",
3098
+ BOOKING = "BOOKING"
3099
+ }
3100
+ export interface BookingData {
3101
+ /** Booking duration in minutes. */
3102
+ durations?: string | null;
3103
+ }
3104
+ export interface EventData {
3105
+ /** Event schedule. */
3106
+ scheduling?: string | null;
3107
+ /** Event location. */
3108
+ location?: string | null;
3109
+ }
3110
+ export interface VideoData {
3111
+ /** Styling for the video's container. */
3112
+ containerData?: PluginContainerData;
3113
+ /** Video details. */
3114
+ video?: Media;
3115
+ /** Video thumbnail details. */
3116
+ thumbnail?: Media;
3117
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
3118
+ disableDownload?: boolean | null;
3119
+ /** Video title. */
3120
+ title?: string | null;
3121
+ /** Video options. */
3122
+ options?: PlaybackOptions;
3123
+ }
3124
+ export interface PlaybackOptions {
3125
+ /** Sets whether the media will automatically start playing. */
3126
+ autoPlay?: boolean | null;
3127
+ /** Sets whether media's will be looped. */
3128
+ playInLoop?: boolean | null;
3129
+ /** Sets whether media's controls will be shown. */
3130
+ showControls?: boolean | null;
3131
+ }
3132
+ export interface EmbedData {
3133
+ /** Styling for the oEmbed node's container. */
3134
+ containerData?: PluginContainerData;
3135
+ /** An [oEmbed](https://www.oembed.com) object. */
3136
+ oembed?: Oembed;
3137
+ /** Origin asset source. */
3138
+ src?: string | null;
3139
+ }
3140
+ export interface Oembed {
3141
+ /** The resource type. */
3142
+ type?: string | null;
3143
+ /** The width of the resource specified in the `url` property in pixels. */
3144
+ width?: number | null;
3145
+ /** The height of the resource specified in the `url` property in pixels. */
3146
+ height?: number | null;
3147
+ /** Resource title. */
3148
+ title?: string | null;
3149
+ /** The source URL for the resource. */
3150
+ url?: string | null;
3151
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
3152
+ html?: string | null;
3153
+ /** The name of the author or owner of the resource. */
3154
+ authorName?: string | null;
3155
+ /** The URL for the author or owner of the resource. */
3156
+ authorUrl?: string | null;
3157
+ /** The name of the resource provider. */
3158
+ providerName?: string | null;
3159
+ /** The URL for the resource provider. */
3160
+ providerUrl?: string | null;
3161
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
3162
+ thumbnailUrl?: string | null;
3163
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
3164
+ thumbnailWidth?: string | null;
3165
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
3166
+ thumbnailHeight?: string | null;
3167
+ /** The URL for an embedded viedo. */
3168
+ videoUrl?: string | null;
3169
+ /** The oEmbed version number. This value must be `1.0`. */
3170
+ version?: string | null;
3171
+ }
3172
+ export interface CollapsibleListData {
3173
+ /** Styling for the collapsible list's container. */
3174
+ containerData?: PluginContainerData;
3175
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
3176
+ expandOnlyOne?: boolean | null;
3177
+ /** Sets which items are expanded when the page loads. */
3178
+ initialExpandedItems?: InitialExpandedItems;
3179
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
3180
+ direction?: Direction;
3181
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
3182
+ isQapageData?: boolean | null;
3183
+ }
3184
+ export declare enum InitialExpandedItems {
3185
+ /** First item will be expended initally */
3186
+ FIRST = "FIRST",
3187
+ /** All items will expended initally */
3188
+ ALL = "ALL",
3189
+ /** All items collapsed initally */
3190
+ NONE = "NONE"
3191
+ }
3192
+ export declare enum Direction {
3193
+ /** Left-to-right */
3194
+ LTR = "LTR",
3195
+ /** Right-to-left */
3196
+ RTL = "RTL"
3197
+ }
3198
+ export interface TableData {
3199
+ /** Styling for the table's container. */
3200
+ containerData?: PluginContainerData;
3201
+ /** The table's dimensions. */
3202
+ dimensions?: Dimensions;
3203
+ /**
3204
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
3205
+ * @deprecated
3206
+ */
3207
+ header?: boolean | null;
3208
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
3209
+ rowHeader?: boolean | null;
3210
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
3211
+ columnHeader?: boolean | null;
3212
+ }
3213
+ export interface Dimensions {
3214
+ /** An array representing relative width of each column in relation to the other columns. */
3215
+ colsWidthRatio?: number[];
3216
+ /** An array representing the height of each row in pixels. */
3217
+ rowsHeight?: number[];
3218
+ /** An array representing the minimum width of each column in pixels. */
3219
+ colsMinWidth?: number[];
3220
+ }
3221
+ export interface TableCellData {
3222
+ /** Styling for the cell's background color and text alignment. */
3223
+ cellStyle?: CellStyle;
3224
+ /** The cell's border colors. */
3225
+ borderColors?: BorderColors;
3226
+ }
3227
+ export declare enum VerticalAlignment {
3228
+ /** Top alignment */
3229
+ TOP = "TOP",
3230
+ /** Middle alignment */
3231
+ MIDDLE = "MIDDLE",
3232
+ /** Bottom alignment */
3233
+ BOTTOM = "BOTTOM"
3234
+ }
3235
+ export interface CellStyle {
3236
+ /** Vertical alignment for the cell's text. */
3237
+ verticalAlignment?: VerticalAlignment;
3238
+ /**
3239
+ * Cell background color as a hexadecimal value.
3240
+ * @format COLOR_HEX
3241
+ */
3242
+ backgroundColor?: string | null;
3243
+ }
3244
+ export interface BorderColors {
3245
+ /**
3246
+ * Left border color as a hexadecimal value.
3247
+ * @format COLOR_HEX
3248
+ */
3249
+ left?: string | null;
3250
+ /**
3251
+ * Right border color as a hexadecimal value.
3252
+ * @format COLOR_HEX
3253
+ */
3254
+ right?: string | null;
3255
+ /**
3256
+ * Top border color as a hexadecimal value.
3257
+ * @format COLOR_HEX
3258
+ */
3259
+ top?: string | null;
3260
+ /**
3261
+ * Bottom border color as a hexadecimal value.
3262
+ * @format COLOR_HEX
3263
+ */
3264
+ bottom?: string | null;
3265
+ }
3266
+ /**
3267
+ * `NullValue` is a singleton enumeration to represent the null value for the
3268
+ * `Value` type union.
3269
+ *
3270
+ * The JSON representation for `NullValue` is JSON `null`.
3271
+ */
3272
+ export declare enum NullValue {
3273
+ /** Null value. */
3274
+ NULL_VALUE = "NULL_VALUE"
3275
+ }
3276
+ /**
3277
+ * `ListValue` is a wrapper around a repeated field of values.
3278
+ *
3279
+ * The JSON representation for `ListValue` is JSON array.
3280
+ */
3281
+ export interface ListValue {
3282
+ /** Repeated field of dynamically typed values. */
3283
+ values?: any[];
3284
+ }
3285
+ export interface AudioData {
3286
+ /** Styling for the audio node's container. */
3287
+ containerData?: PluginContainerData;
3288
+ /** Audio file details. */
3289
+ audio?: Media;
3290
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
3291
+ disableDownload?: boolean | null;
3292
+ /** Cover image. */
3293
+ coverImage?: Media;
3294
+ /** Track name. */
3295
+ name?: string | null;
3296
+ /** Author name. */
3297
+ authorName?: string | null;
3298
+ /** An HTML version of the audio node. */
3299
+ html?: string | null;
3300
+ }
3301
+ export interface OrderedListData {
3302
+ /** Indentation level from 0-4. */
3303
+ indentation?: number;
3304
+ /** Offset level from 0-4. */
3305
+ offset?: number | null;
3306
+ /** List start number. */
3307
+ start?: number | null;
3308
+ }
3309
+ export interface BulletedListData {
3310
+ /** Indentation level from 0-4. */
3311
+ indentation?: number;
3312
+ /** Offset level from 0-4. */
3313
+ offset?: number | null;
3314
+ }
3315
+ export interface BlockquoteData {
3316
+ /** Indentation level from 1-4. */
3317
+ indentation?: number;
3318
+ }
3319
+ export interface CaptionData {
3320
+ textStyle?: TextStyle;
3321
+ }
3322
+ export interface LayoutCellData {
3323
+ /** Size of the cell in 12 columns grid. */
3324
+ colSpan?: number | null;
3325
+ }
3326
+ export interface Metadata {
3327
+ /** Schema version. */
3328
+ version?: number;
3329
+ /**
3330
+ * When the object was created.
3331
+ * @readonly
3332
+ * @deprecated
3333
+ */
3334
+ createdTimestamp?: Date | null;
3335
+ /**
3336
+ * When the object was most recently updated.
3337
+ * @deprecated
3338
+ */
3339
+ updatedTimestamp?: Date | null;
3340
+ /** Object ID. */
3341
+ id?: string | null;
3342
+ }
3343
+ export interface DocumentStyle {
3344
+ /** Styling for H1 nodes. */
3345
+ headerOne?: TextNodeStyle;
3346
+ /** Styling for H2 nodes. */
3347
+ headerTwo?: TextNodeStyle;
3348
+ /** Styling for H3 nodes. */
3349
+ headerThree?: TextNodeStyle;
3350
+ /** Styling for H4 nodes. */
3351
+ headerFour?: TextNodeStyle;
3352
+ /** Styling for H5 nodes. */
3353
+ headerFive?: TextNodeStyle;
3354
+ /** Styling for H6 nodes. */
3355
+ headerSix?: TextNodeStyle;
3356
+ /** Styling for paragraph nodes. */
3357
+ paragraph?: TextNodeStyle;
3358
+ /** Styling for block quote nodes. */
3359
+ blockquote?: TextNodeStyle;
3360
+ /** Styling for code block nodes. */
3361
+ codeBlock?: TextNodeStyle;
3362
+ }
3363
+ export interface TextNodeStyle {
3364
+ /** The decorations to apply to the node. */
3365
+ decorations?: Decoration[];
3366
+ /** Padding and background color for the node. */
3367
+ nodeStyle?: NodeStyle;
3368
+ /** Line height for text in the node. */
3369
+ lineHeight?: string | null;
3370
+ }
3371
+ export interface Badge {
3372
+ /** Badge type. */
3373
+ type?: Type;
3374
+ /**
3375
+ * Badge text.
3376
+ * @maxLength 50
3377
+ */
3378
+ text?: string | null;
3379
+ }
3380
+ export declare enum Type {
3381
+ /** Unknown badge type. */
3382
+ UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
3383
+ /** Urgent badge type. */
3384
+ URGENT = "URGENT",
3385
+ /** Informational badge type. */
3386
+ INFO = "INFO",
3387
+ /** General badge type. */
3388
+ GENERAL = "GENERAL"
3389
+ }
3390
+ export interface EventUpdated {
3391
+ /** Event update timestamp in ISO UTC format. */
3392
+ timestamp?: Date | null;
3393
+ /**
3394
+ * Event ID.
3395
+ * @format GUID
3396
+ */
3397
+ eventId?: string;
3398
+ /** Event location. */
3399
+ location?: EventsLocation;
3400
+ /** Event schedule configuration. */
3401
+ scheduleConfig?: ScheduleConfig;
3402
+ /** Event title. */
3403
+ title?: string;
3404
+ /**
3405
+ * Whether schedule configuration was updated.
3406
+ * @deprecated
3407
+ */
3408
+ scheduleConfigUpdated?: boolean;
3409
+ /** Updated event */
3410
+ event?: Event;
3411
+ }
3412
+ export interface SeatingPlanCategoriesSummaryUpdated {
3413
+ /**
3414
+ * Seating plan id
3415
+ * @format GUID
3416
+ */
3417
+ seatingPlanId?: string;
3418
+ /** External seating plan id */
3419
+ externalSeatingPlanId?: string | null;
3420
+ /**
3421
+ * Ticket counts by category
3422
+ * @maxSize 100
3423
+ */
3424
+ categories?: CategoryDetails[];
3425
+ /**
3426
+ * Summary revision.
3427
+ * @readonly
3428
+ */
3429
+ revision?: string | null;
3430
+ }
3431
+ export interface CategoryDetails {
3432
+ /**
3433
+ * Seating plan id
3434
+ * @format GUID
3435
+ * @readonly
3436
+ */
3437
+ seatingPlanId?: string | null;
3438
+ /**
3439
+ * External seating plan id
3440
+ * @minLength 1
3441
+ * @maxLength 100
3442
+ * @readonly
3443
+ */
3444
+ externalSeatingPlanId?: string | null;
3445
+ /**
3446
+ * External category id
3447
+ * @minLength 1
3448
+ * @maxLength 100
3449
+ * @readonly
3450
+ */
3451
+ externalCategoryId?: string | null;
3452
+ /**
3453
+ * Total capacity in the category
3454
+ * @readonly
3455
+ */
3456
+ totalCapacity?: number | null;
3457
+ /**
3458
+ * Already reserved capacity
3459
+ * @readonly
3460
+ */
3461
+ reserved?: number | null;
3462
+ }
3463
+ export interface DomainEvent extends DomainEventBodyOneOf {
3464
+ createdEvent?: EntityCreatedEvent;
3465
+ updatedEvent?: EntityUpdatedEvent;
3466
+ deletedEvent?: EntityDeletedEvent;
3467
+ actionEvent?: ActionEvent;
3468
+ /**
3469
+ * Unique event ID.
3470
+ * Allows clients to ignore duplicate webhooks.
3471
+ */
3472
+ id?: string;
3473
+ /**
3474
+ * Assumes actions are also always typed to an entity_type
3475
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3476
+ */
3477
+ entityFqdn?: string;
3478
+ /**
3479
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3480
+ * This is although the created/updated/deleted notion is duplication of the oneof types
3481
+ * Example: created/updated/deleted/started/completed/email_opened
3482
+ */
3483
+ slug?: string;
3484
+ /** ID of the entity associated with the event. */
3485
+ entityId?: string;
3486
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3487
+ eventTime?: Date | null;
3488
+ /**
3489
+ * Whether the event was triggered as a result of a privacy regulation application
3490
+ * (for example, GDPR).
3491
+ */
3492
+ triggeredByAnonymizeRequest?: boolean | null;
3493
+ /** If present, indicates the action that triggered the event. */
3494
+ originatedFrom?: string | null;
3495
+ /**
3496
+ * A sequence number defining the order of updates to the underlying entity.
3497
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
3498
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3499
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3500
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
3501
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3502
+ */
3503
+ entityEventSequence?: string | null;
3504
+ }
3505
+ /** @oneof */
3506
+ export interface DomainEventBodyOneOf {
3507
+ createdEvent?: EntityCreatedEvent;
3508
+ updatedEvent?: EntityUpdatedEvent;
3509
+ deletedEvent?: EntityDeletedEvent;
3510
+ actionEvent?: ActionEvent;
3511
+ }
3512
+ export interface EntityCreatedEvent {
3513
+ entityAsJson?: string;
3514
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3515
+ restoreInfo?: RestoreInfo;
3516
+ }
3517
+ export interface RestoreInfo {
3518
+ deletedDate?: Date | null;
3519
+ }
3520
+ export interface EntityUpdatedEvent {
3521
+ /**
3522
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3523
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3524
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3525
+ */
3526
+ currentEntityAsJson?: string;
3527
+ }
3528
+ export interface EntityDeletedEvent {
3529
+ /** Entity that was deleted */
3530
+ deletedEntityAsJson?: string | null;
3531
+ }
3532
+ export interface ActionEvent {
3533
+ bodyAsJson?: string;
3534
+ }
3535
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
3536
+ /** Emitted on a meta site creation. */
3537
+ siteCreated?: SiteCreated;
3538
+ /** Emitted on a meta site transfer completion. */
3539
+ siteTransferred?: SiteTransferred;
3540
+ /** Emitted on a meta site deletion. */
3541
+ siteDeleted?: SiteDeleted;
3542
+ /** Emitted on a meta site restoration. */
3543
+ siteUndeleted?: SiteUndeleted;
3544
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
3545
+ sitePublished?: SitePublished;
3546
+ /** Emitted on a meta site unpublish. */
3547
+ siteUnpublished?: SiteUnpublished;
3548
+ /** Emitted when meta site is marked as template. */
3549
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
3550
+ /** Emitted when meta site is marked as a WixSite. */
3551
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
3552
+ /** Emitted when an application is provisioned (installed). */
3553
+ serviceProvisioned?: ServiceProvisioned;
3554
+ /** Emitted when an application is removed (uninstalled). */
3555
+ serviceRemoved?: ServiceRemoved;
3556
+ /** Emitted when meta site name (URL slug) is changed. */
3557
+ siteRenamedPayload?: SiteRenamed;
3558
+ /** Emitted when meta site was permanently deleted. */
3559
+ hardDeleted?: SiteHardDeleted;
3560
+ /** Emitted on a namespace change. */
3561
+ namespaceChanged?: NamespaceChanged;
3562
+ /** Emitted when Studio is attached. */
3563
+ studioAssigned?: StudioAssigned;
3564
+ /** Emitted when Studio is detached. */
3565
+ studioUnassigned?: StudioUnassigned;
3566
+ /**
3567
+ * A meta site id.
3568
+ * @format GUID
3569
+ */
3570
+ metaSiteId?: string;
3571
+ /** A meta site version. Monotonically increasing. */
3572
+ version?: string;
3573
+ /** A timestamp of the event. */
3574
+ timestamp?: string;
3575
+ /**
3576
+ * TODO(meta-site): Change validation once validations are disabled for consumers
3577
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
3578
+ * @maxSize 4000
3579
+ */
3580
+ assets?: Asset[];
3581
+ }
3582
+ /** @oneof */
3583
+ export interface MetaSiteSpecialEventPayloadOneOf {
3584
+ /** Emitted on a meta site creation. */
3585
+ siteCreated?: SiteCreated;
3586
+ /** Emitted on a meta site transfer completion. */
3587
+ siteTransferred?: SiteTransferred;
3588
+ /** Emitted on a meta site deletion. */
3589
+ siteDeleted?: SiteDeleted;
3590
+ /** Emitted on a meta site restoration. */
3591
+ siteUndeleted?: SiteUndeleted;
3592
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
3593
+ sitePublished?: SitePublished;
3594
+ /** Emitted on a meta site unpublish. */
3595
+ siteUnpublished?: SiteUnpublished;
3596
+ /** Emitted when meta site is marked as template. */
3597
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
3598
+ /** Emitted when meta site is marked as a WixSite. */
3599
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
3600
+ /** Emitted when an application is provisioned (installed). */
3601
+ serviceProvisioned?: ServiceProvisioned;
3602
+ /** Emitted when an application is removed (uninstalled). */
3603
+ serviceRemoved?: ServiceRemoved;
3604
+ /** Emitted when meta site name (URL slug) is changed. */
3605
+ siteRenamedPayload?: SiteRenamed;
3606
+ /** Emitted when meta site was permanently deleted. */
3607
+ hardDeleted?: SiteHardDeleted;
3608
+ /** Emitted on a namespace change. */
3609
+ namespaceChanged?: NamespaceChanged;
3610
+ /** Emitted when Studio is attached. */
3611
+ studioAssigned?: StudioAssigned;
3612
+ /** Emitted when Studio is detached. */
3613
+ studioUnassigned?: StudioUnassigned;
3614
+ }
3615
+ export interface Asset {
3616
+ /**
3617
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
3618
+ * @maxLength 36
3619
+ */
3620
+ appDefId?: string;
3621
+ /**
3622
+ * An instance id. For legacy reasons may be UUID or a string.
3623
+ * @maxLength 200
3624
+ */
3625
+ instanceId?: string;
3626
+ /** An application state. */
3627
+ state?: State;
3628
+ }
3629
+ export declare enum State {
3630
+ UNKNOWN = "UNKNOWN",
3631
+ ENABLED = "ENABLED",
3632
+ DISABLED = "DISABLED",
3633
+ PENDING = "PENDING",
3634
+ DEMO = "DEMO"
3635
+ }
3636
+ export interface SiteCreated {
3637
+ /**
3638
+ * A template identifier (empty if not created from a template).
3639
+ * @maxLength 36
3640
+ */
3641
+ originTemplateId?: string;
3642
+ /**
3643
+ * An account id of the owner.
3644
+ * @format GUID
3645
+ */
3646
+ ownerId?: string;
3647
+ /** A context in which meta site was created. */
3648
+ context?: SiteCreatedContext;
3649
+ /**
3650
+ * A meta site id from which this site was created.
3651
+ *
3652
+ * In case of a creation from a template it's a template id.
3653
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
3654
+ * @format GUID
3655
+ */
3656
+ originMetaSiteId?: string | null;
3657
+ /**
3658
+ * A meta site name (URL slug).
3659
+ * @maxLength 20
3660
+ */
3661
+ siteName?: string;
3662
+ /** A namespace. */
3663
+ namespace?: Namespace;
3664
+ }
3665
+ export declare enum SiteCreatedContext {
3666
+ /** A valid option, we don't expose all reasons why site might be created. */
3667
+ OTHER = "OTHER",
3668
+ /** A meta site was created from template. */
3669
+ FROM_TEMPLATE = "FROM_TEMPLATE",
3670
+ /** A meta site was created by copying of the transfferred meta site. */
3671
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
3672
+ /** A copy of existing meta site. */
3673
+ DUPLICATE = "DUPLICATE",
3674
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
3675
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
3676
+ /** deprecated A meta site was created for Flash editor. */
3677
+ FLASH = "FLASH"
3678
+ }
3679
+ export declare enum Namespace {
3680
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
3681
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
3682
+ WIX = "WIX",
3683
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3684
+ SHOUT_OUT = "SHOUT_OUT",
3685
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3686
+ ALBUMS = "ALBUMS",
3687
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3688
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
3689
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3690
+ HOTELS = "HOTELS",
3691
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3692
+ CLUBS = "CLUBS",
3693
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3694
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
3695
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3696
+ DEV_SITE = "DEV_SITE",
3697
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3698
+ LOGOS = "LOGOS",
3699
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
3700
+ VIDEO_MAKER = "VIDEO_MAKER",
3701
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
3702
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
3703
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
3704
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
3705
+ /**
3706
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
3707
+ *
3708
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
3709
+ */
3710
+ HTML_DRAFT = "HTML_DRAFT",
3711
+ /**
3712
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
3713
+ * Will be accessible from Site List and will not have a website app.
3714
+ * Once the user attaches a site, the site will become a regular wixsite.
3715
+ */
3716
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
3717
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
3718
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
3719
+ /** It is to be used in the Business First efforts. */
3720
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
3721
+ /** Bookings business flow with no site. */
3722
+ ANYWHERE = "ANYWHERE",
3723
+ /** Namespace for Headless Backoffice with no editor */
3724
+ HEADLESS = "HEADLESS",
3725
+ /**
3726
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
3727
+ * The site will be used for account level CSM feature for enterprise
3728
+ */
3729
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
3730
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
3731
+ RISE = "RISE",
3732
+ /**
3733
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
3734
+ * There's a blank site behind the scene but it's blank).
3735
+ * The Mobile company will be the owner of this namespace.
3736
+ */
3737
+ BRANDED_FIRST = "BRANDED_FIRST",
3738
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
3739
+ NOWNIA = "NOWNIA",
3740
+ /**
3741
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
3742
+ * The Partners company owns this namespace.
3743
+ */
3744
+ UGC_TEMPLATE = "UGC_TEMPLATE",
3745
+ /** Codux Headless Sites */
3746
+ CODUX = "CODUX",
3747
+ /** Bobb - AI Design Creator. */
3748
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
3749
+ /**
3750
+ * Shared Blog Site is a unique single site across Enterprise account,
3751
+ * This site will hold all Blog posts related to the Marketing product.
3752
+ */
3753
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
3754
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
3755
+ STANDALONE_FORMS = "STANDALONE_FORMS"
3756
+ }
3757
+ /** Site transferred to another user. */
3758
+ export interface SiteTransferred {
3759
+ /**
3760
+ * A previous owner id (user that transfers meta site).
3761
+ * @format GUID
3762
+ */
3763
+ oldOwnerId?: string;
3764
+ /**
3765
+ * A new owner id (user that accepts meta site).
3766
+ * @format GUID
3767
+ */
3768
+ newOwnerId?: string;
3769
+ }
3770
+ /** Soft deletion of the meta site. Could be restored. */
3771
+ export interface SiteDeleted {
3772
+ /** A deletion context. */
3773
+ deleteContext?: DeleteContext;
3774
+ }
3775
+ export interface DeleteContext {
3776
+ /** When the meta site was deleted. */
3777
+ dateDeleted?: Date | null;
3778
+ /** A status. */
3779
+ deleteStatus?: DeleteStatus;
3780
+ /**
3781
+ * A reason (flow).
3782
+ * @maxLength 255
3783
+ */
3784
+ deleteOrigin?: string;
3785
+ /**
3786
+ * A service that deleted it.
3787
+ * @maxLength 255
3788
+ */
3789
+ initiatorId?: string | null;
3790
+ }
3791
+ export declare enum DeleteStatus {
3792
+ UNKNOWN = "UNKNOWN",
3793
+ TRASH = "TRASH",
3794
+ DELETED = "DELETED",
3795
+ PENDING_PURGE = "PENDING_PURGE",
3796
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
3797
+ }
3798
+ /** Restoration of the meta site. */
3799
+ export interface SiteUndeleted {
3800
+ }
3801
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
3802
+ export interface SitePublished {
3803
+ }
3804
+ export interface SiteUnpublished {
3805
+ /**
3806
+ * A list of URLs previously associated with the meta site.
3807
+ * @maxLength 4000
3808
+ * @maxSize 10000
3809
+ */
3810
+ urls?: string[];
3811
+ }
3812
+ export interface SiteMarkedAsTemplate {
3813
+ }
3814
+ export interface SiteMarkedAsWixSite {
3815
+ }
3816
+ /**
3817
+ * Represents a service provisioned a site.
3818
+ *
3819
+ * Note on `origin_instance_id`:
3820
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
3821
+ * This is because of the following scenario:
3822
+ *
3823
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
3824
+ * such as a product catalog. When you create a site from this template, you inherit this
3825
+ * default product catalog. However, if the template's product catalog is modified,
3826
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
3827
+ * your site remains consistent with what you initially received and does not include any
3828
+ * changes made to the original template afterward.
3829
+ * To ensure this, the TPA on the template gets a new instance_id.
3830
+ */
3831
+ export interface ServiceProvisioned {
3832
+ /**
3833
+ * Either UUID or EmbeddedServiceType.
3834
+ * @maxLength 36
3835
+ */
3836
+ appDefId?: string;
3837
+ /**
3838
+ * Not only UUID. Something here could be something weird.
3839
+ * @maxLength 36
3840
+ */
3841
+ instanceId?: string;
3842
+ /**
3843
+ * An instance id from which this instance is originated.
3844
+ * @maxLength 36
3845
+ */
3846
+ originInstanceId?: string;
3847
+ /**
3848
+ * A version.
3849
+ * @maxLength 500
3850
+ */
3851
+ version?: string | null;
3852
+ /**
3853
+ * The origin meta site id
3854
+ * @format GUID
3855
+ */
3856
+ originMetaSiteId?: string | null;
3857
+ }
3858
+ export interface ServiceRemoved {
3859
+ /**
3860
+ * Either UUID or EmbeddedServiceType.
3861
+ * @maxLength 36
3862
+ */
3863
+ appDefId?: string;
3864
+ /**
3865
+ * Not only UUID. Something here could be something weird.
3866
+ * @maxLength 36
3867
+ */
3868
+ instanceId?: string;
3869
+ /**
3870
+ * A version.
3871
+ * @maxLength 500
3872
+ */
3873
+ version?: string | null;
3874
+ }
3875
+ /** Rename of the site. Meaning, free public url has been changed as well. */
3876
+ export interface SiteRenamed {
3877
+ /**
3878
+ * A new meta site name (URL slug).
3879
+ * @maxLength 20
3880
+ */
3881
+ newSiteName?: string;
3882
+ /**
3883
+ * A previous meta site name (URL slug).
3884
+ * @maxLength 255
3885
+ */
3886
+ oldSiteName?: string;
3887
+ }
3888
+ /**
3889
+ * Hard deletion of the meta site.
3890
+ *
3891
+ * Could not be restored. Therefore it's desirable to cleanup data.
3892
+ */
3893
+ export interface SiteHardDeleted {
3894
+ /** A deletion context. */
3895
+ deleteContext?: DeleteContext;
3896
+ }
3897
+ export interface NamespaceChanged {
3898
+ /** A previous namespace. */
3899
+ oldNamespace?: Namespace;
3900
+ /** A new namespace. */
3901
+ newNamespace?: Namespace;
3902
+ }
3903
+ /** Assigned Studio editor */
3904
+ export interface StudioAssigned {
3905
+ }
3906
+ /** Unassigned Studio editor */
3907
+ export interface StudioUnassigned {
3908
+ }
3909
+ export interface GetTicketDefinitionFromTrashBinRequest {
3910
+ /**
3911
+ * Ticket definition ID.
3912
+ * @format GUID
3913
+ */
3914
+ ticketDefinitionId?: string;
3915
+ /**
3916
+ * Requested fields. Not implemented.
3917
+ * @maxSize 5
3918
+ */
3919
+ fields?: Field[];
3920
+ }
3921
+ export interface GetTicketDefinitionFromTrashBinResponse {
3922
+ /** The requested ticket definition. */
3923
+ ticketDefinition?: TicketDefinition;
3924
+ }
3925
+ export interface ScheduleLegacyTimeCapsuleTaskRequest {
3926
+ /**
3927
+ * Definition ID.
3928
+ * @format GUID
3929
+ */
3930
+ ticketDefinitionId?: string;
3931
+ }
3932
+ export interface MessageEnvelope {
3933
+ /**
3934
+ * App instance ID.
3935
+ * @format GUID
3936
+ */
3937
+ instanceId?: string | null;
3938
+ /**
3939
+ * Event type.
3940
+ * @maxLength 150
3941
+ */
3942
+ eventType?: string;
3943
+ /** The identification type and identity data. */
3944
+ identity?: IdentificationData;
3945
+ /** Stringify payload. */
3946
+ data?: string;
3947
+ }
3948
+ export interface IdentificationData extends IdentificationDataIdOneOf {
3949
+ /**
3950
+ * ID of a site visitor that has not logged in to the site.
3951
+ * @format GUID
3952
+ */
3953
+ anonymousVisitorId?: string;
3954
+ /**
3955
+ * ID of a site visitor that has logged in to the site.
3956
+ * @format GUID
3957
+ */
3958
+ memberId?: string;
3959
+ /**
3960
+ * ID of a Wix user (site owner, contributor, etc.).
3961
+ * @format GUID
3962
+ */
3963
+ wixUserId?: string;
3964
+ /**
3965
+ * ID of an app.
3966
+ * @format GUID
3967
+ */
3968
+ appId?: string;
3969
+ /** @readonly */
3970
+ identityType?: WebhookIdentityType;
3971
+ }
3972
+ /** @oneof */
3973
+ export interface IdentificationDataIdOneOf {
3974
+ /**
3975
+ * ID of a site visitor that has not logged in to the site.
3976
+ * @format GUID
3977
+ */
3978
+ anonymousVisitorId?: string;
3979
+ /**
3980
+ * ID of a site visitor that has logged in to the site.
3981
+ * @format GUID
3982
+ */
3983
+ memberId?: string;
3984
+ /**
3985
+ * ID of a Wix user (site owner, contributor, etc.).
3986
+ * @format GUID
3987
+ */
3988
+ wixUserId?: string;
3989
+ /**
3990
+ * ID of an app.
3991
+ * @format GUID
3992
+ */
3993
+ appId?: string;
3994
+ }
3995
+ export declare enum WebhookIdentityType {
3996
+ UNKNOWN = "UNKNOWN",
3997
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3998
+ MEMBER = "MEMBER",
3999
+ WIX_USER = "WIX_USER",
4000
+ APP = "APP"
4001
+ }
4002
+ export interface GetTicketDefinitionSummaryRequest {
4003
+ /**
4004
+ * Ticket definition id.
4005
+ * @format GUID
4006
+ */
4007
+ ticketDefinitionId?: string | null;
4008
+ }
4009
+ export interface GetTicketDefinitionSummaryResponse {
4010
+ /** Summary. */
4011
+ summary?: TicketDefinitionSummary;
4012
+ }
4013
+ export interface TicketDefinitionSummary {
4014
+ /**
4015
+ * Ticket definition ID.
4016
+ * @format GUID
4017
+ * @readonly
4018
+ */
4019
+ definitionId?: string | null;
4020
+ /**
4021
+ * Event ID to which the ticket definition summary belongs.
4022
+ * @format GUID
4023
+ * @readonly
4024
+ */
4025
+ eventId?: string | null;
4026
+ /**
4027
+ * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
4028
+ * @readonly
4029
+ */
4030
+ updatedDate?: Date | null;
4031
+ /**
4032
+ * Reserved count.
4033
+ * @readonly
4034
+ */
4035
+ reservedCount?: number;
4036
+ /**
4037
+ * Sold count.
4038
+ * @readonly
4039
+ */
4040
+ soldCount?: number;
4041
+ /**
4042
+ * Paid exists.
4043
+ * @readonly
4044
+ */
4045
+ paidExists?: boolean;
4046
+ }
4047
+ export interface ListEventTicketingSummaryRequest {
4048
+ /**
4049
+ * Event ID.
4050
+ * @format GUID
4051
+ * @minSize 1
4052
+ * @maxSize 1000
4053
+ */
4054
+ eventId?: string[];
4055
+ }
4056
+ export interface ListEventTicketingSummaryResponse {
4057
+ /** Ticketing summaries. */
4058
+ summaries?: EventTicketingSummary[];
4059
+ }
4060
+ export interface EventTicketingSummary {
4061
+ /**
4062
+ * Event ID to which the ticketing summary belongs.
4063
+ * @format GUID
4064
+ * @readonly
4065
+ */
4066
+ eventId?: string | null;
4067
+ /**
4068
+ * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
4069
+ * @readonly
4070
+ */
4071
+ updatedDate?: Date | null;
4072
+ /**
4073
+ * Whether all tickets are sold for this event.
4074
+ * @readonly
4075
+ */
4076
+ soldOut?: boolean | null;
4077
+ /**
4078
+ * Price of lowest priced ticket.
4079
+ * @readonly
4080
+ */
4081
+ lowestTicketPrice?: CommonMoney;
4082
+ /**
4083
+ * Price of highest priced ticket.
4084
+ * @readonly
4085
+ */
4086
+ highestTicketPrice?: CommonMoney;
4087
+ /**
4088
+ * Currency used in event transactions.
4089
+ * @minLength 3
4090
+ * @maxLength 3
4091
+ * @readonly
4092
+ */
4093
+ currency?: string | null;
4094
+ /**
4095
+ * Formatted price of lowest priced ticket.
4096
+ * @maxLength 50
4097
+ * @readonly
4098
+ */
4099
+ lowestTicketPriceFormatted?: string | null;
4100
+ /**
4101
+ * Formatted price of highest priced ticket.
4102
+ * @maxLength 50
4103
+ * @readonly
4104
+ */
4105
+ highestTicketPriceFormatted?: string | null;
4106
+ }
4107
+ export interface ReservationCreated {
4108
+ /** Reservation created timestamp in ISO UTC format. */
4109
+ timestamp?: Date | null;
4110
+ /**
4111
+ * Event ID.
4112
+ * @format GUID
4113
+ */
4114
+ eventId?: string;
4115
+ /**
4116
+ * Reservation ID.
4117
+ * Can be used to retrieve a reservation invoice.
4118
+ * @format GUID
4119
+ */
4120
+ reservationId?: string;
4121
+ /** Reservation expiration timestamp. */
4122
+ expires?: Date | null;
4123
+ /** Reservation status. */
4124
+ status?: ReservationStatus;
4125
+ /**
4126
+ * Reservation ticket quantities.
4127
+ * @maxSize 50
4128
+ */
4129
+ quantities?: TicketQuantity[];
4130
+ /** Reservation update timestamp. */
4131
+ updatedDate?: Date | null;
4132
+ /**
4133
+ * Reservation counts.
4134
+ * @maxSize 50
4135
+ */
4136
+ counts?: ReservationCount[];
4137
+ }
4138
+ export declare enum ReservationStatus {
4139
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
4140
+ RESERVATION_PENDING = "RESERVATION_PENDING",
4141
+ /** The reservation is confirmed and will not expire. */
4142
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
4143
+ /** The reservation is canceled because of non payment. */
4144
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
4145
+ /** The reservation is canceled manually by the buyer. */
4146
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
4147
+ /** The reservation is expired. */
4148
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
4149
+ }
4150
+ export interface TicketQuantity {
4151
+ /**
4152
+ * Ticket definition ID.
4153
+ * @format GUID
4154
+ */
4155
+ ticketDefinitionId?: string | null;
4156
+ /** Quantity. */
4157
+ quantity?: number | null;
4158
+ /** Quantity update timestamp. */
4159
+ updatedDate?: Date | null;
4160
+ }
4161
+ export interface ReservationCount {
4162
+ /** Reservation Count snapshot timestamp. */
4163
+ timestamp?: Date | null;
4164
+ /**
4165
+ * Ticket Definition ID.
4166
+ * @format GUID
4167
+ */
4168
+ ticketDefinitionId?: string;
4169
+ /** Confirmed reservation count. */
4170
+ confirmedCount?: number;
4171
+ /** Pending reservation count. */
4172
+ pendingCount?: number;
4173
+ /** True if paid ticket reservation exist. */
4174
+ paidExists?: boolean;
4175
+ }
4176
+ export interface ReservationUpdated {
4177
+ /** Reservation updated timestamp. */
4178
+ timestamp?: Date | null;
4179
+ /**
4180
+ * Event ID.
4181
+ * @format GUID
4182
+ */
4183
+ eventId?: string;
4184
+ /**
4185
+ * Reservation ID.
4186
+ * Can be used to retrieve a reservation invoice.
4187
+ * @format GUID
4188
+ */
4189
+ reservationId?: string;
4190
+ /** Reservation status. */
4191
+ status?: ReservationStatus;
4192
+ /** Reservation expiration timestamp. */
4193
+ expires?: Date | null;
4194
+ /**
4195
+ * Reservation ticket quantities.
4196
+ * @maxSize 50
4197
+ */
4198
+ quantities?: TicketQuantity[];
4199
+ /** Reservation update timestamp. */
4200
+ updatedDate?: Date | null;
4201
+ /**
4202
+ * Reservation counts.
4203
+ * @maxSize 50
4204
+ */
4205
+ counts?: ReservationCount[];
4206
+ }