@wix/auto_sdk_events_ticket-definitions-v-2 1.0.28 → 1.0.29

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