@wix/auto_sdk_events_ticket-definitions-v-2 1.0.19 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +109 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +585 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +237 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +306 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +705 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
- package/build/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.mts → cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1341 -0
- package/build/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +46 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +571 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +200 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +232 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +701 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
- package/build/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.ts → es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1303 -0
- package/build/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +109 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +585 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +237 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +306 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +705 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
- package/build/internal/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.ts → cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1341 -0
- package/build/internal/cjs/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.d.ts +46 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js +46 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.context.js.map +1 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.d.ts +79 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js +571 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.http.js.map +1 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.d.ts +29 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js +200 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.meta.js.map +1 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.d.ts +148 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js +232 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.public.js.map +1 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.d.ts +4206 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js +701 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.types.js.map +1 -0
- package/build/internal/{events-v3-ticket-definition-ticket-definitions-v-2.universal-ww5IkE5x.d.mts → es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.d.ts} +687 -349
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js +1303 -0
- package/build/internal/es/src/events-v3-ticket-definition-ticket-definitions-v-2.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -179
- package/build/index.d.ts +0 -179
- package/build/index.js +0 -1885
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -1786
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -179
- package/build/internal/index.d.ts +0 -179
- package/build/internal/index.js +0 -1885
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -1786
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -754
- package/build/internal/meta.d.ts +0 -754
- package/build/internal/meta.js +0 -761
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -724
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -754
- package/build/meta.d.ts +0 -754
- package/build/meta.js +0 -761
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -724
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
export interface TicketDefinition {
|
|
2
3
|
/**
|
|
3
4
|
* Ticket definition ID.
|
|
4
5
|
* @format GUID
|
|
@@ -87,7 +88,7 @@ interface TicketDefinition {
|
|
|
87
88
|
*/
|
|
88
89
|
eventDetails?: EventDetails;
|
|
89
90
|
}
|
|
90
|
-
interface SalePeriod {
|
|
91
|
+
export interface SalePeriod {
|
|
91
92
|
/** Ticket sale start timestamp. */
|
|
92
93
|
startDate?: Date | null;
|
|
93
94
|
/** Ticket sale end timestamp. */
|
|
@@ -95,7 +96,7 @@ interface SalePeriod {
|
|
|
95
96
|
/** Whether to display the ticket if it's not available to buy. */
|
|
96
97
|
displayNotOnSale?: boolean;
|
|
97
98
|
}
|
|
98
|
-
interface PricingMethod extends PricingMethodPriceOneOf {
|
|
99
|
+
export interface PricingMethod extends PricingMethodPriceOneOf {
|
|
99
100
|
/** Same ticket price for everyone. */
|
|
100
101
|
fixedPrice?: CommonMoney;
|
|
101
102
|
/** 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. */
|
|
@@ -114,7 +115,7 @@ interface PricingMethod extends PricingMethodPriceOneOf {
|
|
|
114
115
|
free?: boolean;
|
|
115
116
|
}
|
|
116
117
|
/** @oneof */
|
|
117
|
-
interface PricingMethodPriceOneOf {
|
|
118
|
+
export interface PricingMethodPriceOneOf {
|
|
118
119
|
/** Same ticket price for everyone. */
|
|
119
120
|
fixedPrice?: CommonMoney;
|
|
120
121
|
/** 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. */
|
|
@@ -126,7 +127,7 @@ interface PricingMethodPriceOneOf {
|
|
|
126
127
|
* Money.
|
|
127
128
|
* Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
|
|
128
129
|
*/
|
|
129
|
-
interface CommonMoney {
|
|
130
|
+
export interface CommonMoney {
|
|
130
131
|
/**
|
|
131
132
|
* 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
133
|
* @format DECIMAL_VALUE
|
|
@@ -138,14 +139,14 @@ interface CommonMoney {
|
|
|
138
139
|
*/
|
|
139
140
|
currency?: string;
|
|
140
141
|
}
|
|
141
|
-
interface PricingOptions {
|
|
142
|
+
export interface PricingOptions {
|
|
142
143
|
/**
|
|
143
144
|
* Ticket price option details.
|
|
144
145
|
* @maxSize 100
|
|
145
146
|
*/
|
|
146
147
|
optionDetails?: OptionDetails[];
|
|
147
148
|
}
|
|
148
|
-
interface OptionDetails {
|
|
149
|
+
export interface OptionDetails {
|
|
149
150
|
/**
|
|
150
151
|
* Ticket price option ID.
|
|
151
152
|
* @format GUID
|
|
@@ -160,7 +161,7 @@ interface OptionDetails {
|
|
|
160
161
|
/** Ticket price. */
|
|
161
162
|
price?: CommonMoney;
|
|
162
163
|
}
|
|
163
|
-
declare enum PricingTypeEnumType {
|
|
164
|
+
export declare enum PricingTypeEnumType {
|
|
164
165
|
/** Undefined pricing type. */
|
|
165
166
|
UNKNOWN_PRICING_TYPE = "UNKNOWN_PRICING_TYPE",
|
|
166
167
|
/** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */
|
|
@@ -168,7 +169,7 @@ declare enum PricingTypeEnumType {
|
|
|
168
169
|
/** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */
|
|
169
170
|
DONATION = "DONATION"
|
|
170
171
|
}
|
|
171
|
-
declare enum FeeTypeEnumType {
|
|
172
|
+
export declare enum FeeTypeEnumType {
|
|
172
173
|
/** Unknown fee type. */
|
|
173
174
|
UNKNOWN_FEE_TYPE = "UNKNOWN_FEE_TYPE",
|
|
174
175
|
/** 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. */
|
|
@@ -178,7 +179,7 @@ declare enum FeeTypeEnumType {
|
|
|
178
179
|
/** Ticket service fee is not collected. Available only for free tickets and legacy users. */
|
|
179
180
|
NO_FEE = "NO_FEE"
|
|
180
181
|
}
|
|
181
|
-
declare enum SaleStatusEnumStatus {
|
|
182
|
+
export declare enum SaleStatusEnumStatus {
|
|
182
183
|
/** Undefined sale status. */
|
|
183
184
|
UNKNOWN_SALE_STATUS = "UNKNOWN_SALE_STATUS",
|
|
184
185
|
/** Tickets are not on sale yet. */
|
|
@@ -188,7 +189,7 @@ declare enum SaleStatusEnumStatus {
|
|
|
188
189
|
/** Tickets are not on sale. */
|
|
189
190
|
SALE_ENDED = "SALE_ENDED"
|
|
190
191
|
}
|
|
191
|
-
interface SalesDetails {
|
|
192
|
+
export interface SalesDetails {
|
|
192
193
|
/**
|
|
193
194
|
* Number of tickets that have not been purchased yet. The field is `null` if the ticket quantity is unlimited.
|
|
194
195
|
* @readonly
|
|
@@ -210,7 +211,7 @@ interface SalesDetails {
|
|
|
210
211
|
*/
|
|
211
212
|
soldOut?: boolean | null;
|
|
212
213
|
}
|
|
213
|
-
interface ExtendedFields {
|
|
214
|
+
export interface ExtendedFields {
|
|
214
215
|
/**
|
|
215
216
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
216
217
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -221,7 +222,7 @@ interface ExtendedFields {
|
|
|
221
222
|
*/
|
|
222
223
|
namespaces?: Record<string, Record<string, any>>;
|
|
223
224
|
}
|
|
224
|
-
interface EventDetails {
|
|
225
|
+
export interface EventDetails {
|
|
225
226
|
/**
|
|
226
227
|
* Event title.
|
|
227
228
|
* @minLength 1
|
|
@@ -256,7 +257,7 @@ interface EventDetails {
|
|
|
256
257
|
*/
|
|
257
258
|
status?: Status;
|
|
258
259
|
}
|
|
259
|
-
interface Location {
|
|
260
|
+
export interface Location {
|
|
260
261
|
/**
|
|
261
262
|
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
262
263
|
* @maxLength 50
|
|
@@ -269,7 +270,7 @@ interface Location {
|
|
|
269
270
|
/** Whether the event location is TBD. */
|
|
270
271
|
locationTbd?: boolean | null;
|
|
271
272
|
}
|
|
272
|
-
declare enum LocationType {
|
|
273
|
+
export declare enum LocationType {
|
|
273
274
|
/** Unknown location type. */
|
|
274
275
|
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
275
276
|
/** Event is on-site at a specific physical location. */
|
|
@@ -278,7 +279,7 @@ declare enum LocationType {
|
|
|
278
279
|
ONLINE = "ONLINE"
|
|
279
280
|
}
|
|
280
281
|
/** Physical address */
|
|
281
|
-
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
282
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
282
283
|
/** Street address. */
|
|
283
284
|
streetAddress?: CommonStreetAddress;
|
|
284
285
|
/**
|
|
@@ -313,7 +314,7 @@ interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
313
314
|
addressLine2?: string | null;
|
|
314
315
|
}
|
|
315
316
|
/** @oneof */
|
|
316
|
-
interface CommonAddressStreetOneOf {
|
|
317
|
+
export interface CommonAddressStreetOneOf {
|
|
317
318
|
/** Street address. */
|
|
318
319
|
streetAddress?: CommonStreetAddress;
|
|
319
320
|
/**
|
|
@@ -322,7 +323,7 @@ interface CommonAddressStreetOneOf {
|
|
|
322
323
|
*/
|
|
323
324
|
addressLine?: string | null;
|
|
324
325
|
}
|
|
325
|
-
interface CommonStreetAddress {
|
|
326
|
+
export interface CommonStreetAddress {
|
|
326
327
|
/**
|
|
327
328
|
* Street number.
|
|
328
329
|
* @maxLength 100
|
|
@@ -334,7 +335,7 @@ interface CommonStreetAddress {
|
|
|
334
335
|
*/
|
|
335
336
|
name?: string;
|
|
336
337
|
}
|
|
337
|
-
interface CommonAddressLocation {
|
|
338
|
+
export interface CommonAddressLocation {
|
|
338
339
|
/**
|
|
339
340
|
* Address latitude coordinates.
|
|
340
341
|
* @min -90
|
|
@@ -348,7 +349,7 @@ interface CommonAddressLocation {
|
|
|
348
349
|
*/
|
|
349
350
|
longitude?: number | null;
|
|
350
351
|
}
|
|
351
|
-
interface CommonSubdivision {
|
|
352
|
+
export interface CommonSubdivision {
|
|
352
353
|
/**
|
|
353
354
|
* Short subdivision code.
|
|
354
355
|
* @maxLength 100
|
|
@@ -360,7 +361,7 @@ interface CommonSubdivision {
|
|
|
360
361
|
*/
|
|
361
362
|
name?: string;
|
|
362
363
|
}
|
|
363
|
-
declare enum SubdivisionSubdivisionType {
|
|
364
|
+
export declare enum SubdivisionSubdivisionType {
|
|
364
365
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
365
366
|
/** State */
|
|
366
367
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -375,7 +376,7 @@ declare enum SubdivisionSubdivisionType {
|
|
|
375
376
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
376
377
|
COUNTRY = "COUNTRY"
|
|
377
378
|
}
|
|
378
|
-
interface DateAndTimeSettings {
|
|
379
|
+
export interface DateAndTimeSettings {
|
|
379
380
|
/** Whether the event date and time are TBD. */
|
|
380
381
|
dateAndTimeTbd?: boolean | null;
|
|
381
382
|
/**
|
|
@@ -406,7 +407,7 @@ interface DateAndTimeSettings {
|
|
|
406
407
|
/** Formatted date and time settings. */
|
|
407
408
|
formatted?: Formatted;
|
|
408
409
|
}
|
|
409
|
-
declare enum RecurrenceStatusStatus {
|
|
410
|
+
export declare enum RecurrenceStatusStatus {
|
|
410
411
|
/** Unknown recurrance status. */
|
|
411
412
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
412
413
|
/** Event happens only once and can last multiple days. */
|
|
@@ -420,7 +421,7 @@ declare enum RecurrenceStatusStatus {
|
|
|
420
421
|
/** Latest canceled event in a schedule of recurring events */
|
|
421
422
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
422
423
|
}
|
|
423
|
-
interface Recurrences {
|
|
424
|
+
export interface Recurrences {
|
|
424
425
|
/**
|
|
425
426
|
* Individual event dates.
|
|
426
427
|
* @maxSize 1000
|
|
@@ -433,7 +434,7 @@ interface Recurrences {
|
|
|
433
434
|
*/
|
|
434
435
|
categoryId?: string | null;
|
|
435
436
|
}
|
|
436
|
-
interface Occurrence {
|
|
437
|
+
export interface Occurrence {
|
|
437
438
|
/** Event start date. */
|
|
438
439
|
startDate?: Date | null;
|
|
439
440
|
/** Event end date. */
|
|
@@ -446,7 +447,7 @@ interface Occurrence {
|
|
|
446
447
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
447
448
|
showTimeZone?: boolean;
|
|
448
449
|
}
|
|
449
|
-
interface Formatted {
|
|
450
|
+
export interface Formatted {
|
|
450
451
|
/**
|
|
451
452
|
* Formatted date and time representation. <br>
|
|
452
453
|
* 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>
|
|
@@ -480,7 +481,7 @@ interface Formatted {
|
|
|
480
481
|
*/
|
|
481
482
|
endTime?: string | null;
|
|
482
483
|
}
|
|
483
|
-
declare enum Status {
|
|
484
|
+
export declare enum Status {
|
|
484
485
|
/** Unknown event status. */
|
|
485
486
|
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
486
487
|
/** Event is published and scheduled to start. */
|
|
@@ -494,7 +495,7 @@ declare enum Status {
|
|
|
494
495
|
/** Event is not public. */
|
|
495
496
|
DRAFT = "DRAFT"
|
|
496
497
|
}
|
|
497
|
-
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
498
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
498
499
|
/**
|
|
499
500
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
500
501
|
* @format GUID
|
|
@@ -523,7 +524,7 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
523
524
|
hardPurge?: boolean;
|
|
524
525
|
}
|
|
525
526
|
/** @oneof */
|
|
526
|
-
interface InvalidateCacheGetByOneOf {
|
|
527
|
+
export interface InvalidateCacheGetByOneOf {
|
|
527
528
|
/**
|
|
528
529
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
529
530
|
* @format GUID
|
|
@@ -543,7 +544,7 @@ interface InvalidateCacheGetByOneOf {
|
|
|
543
544
|
/** Invalidate by file (for media files such as PDFs) */
|
|
544
545
|
file?: File;
|
|
545
546
|
}
|
|
546
|
-
interface App {
|
|
547
|
+
export interface App {
|
|
547
548
|
/**
|
|
548
549
|
* The AppDefId
|
|
549
550
|
* @minLength 1
|
|
@@ -555,7 +556,7 @@ interface App {
|
|
|
555
556
|
*/
|
|
556
557
|
instanceId?: string;
|
|
557
558
|
}
|
|
558
|
-
interface Page {
|
|
559
|
+
export interface Page {
|
|
559
560
|
/**
|
|
560
561
|
* the msid the page is on
|
|
561
562
|
* @format GUID
|
|
@@ -567,7 +568,7 @@ interface Page {
|
|
|
567
568
|
*/
|
|
568
569
|
pageId?: string;
|
|
569
570
|
}
|
|
570
|
-
interface URI {
|
|
571
|
+
export interface URI {
|
|
571
572
|
/**
|
|
572
573
|
* the msid the URI is on
|
|
573
574
|
* @format GUID
|
|
@@ -579,7 +580,7 @@ interface URI {
|
|
|
579
580
|
*/
|
|
580
581
|
uriPath?: string;
|
|
581
582
|
}
|
|
582
|
-
interface File {
|
|
583
|
+
export interface File {
|
|
583
584
|
/**
|
|
584
585
|
* the msid the file is related to
|
|
585
586
|
* @format GUID
|
|
@@ -592,19 +593,19 @@ interface File {
|
|
|
592
593
|
*/
|
|
593
594
|
fileName?: string;
|
|
594
595
|
}
|
|
595
|
-
interface SalePeriodUpdated {
|
|
596
|
+
export interface SalePeriodUpdated {
|
|
596
597
|
/** Ticket definition sale period after update. */
|
|
597
598
|
afterUpdate?: SalePeriod;
|
|
598
599
|
}
|
|
599
|
-
interface TicketDefinitionSaleStarted {
|
|
600
|
+
export interface TicketDefinitionSaleStarted {
|
|
600
601
|
/** Ticket definition. */
|
|
601
602
|
ticketDefinition?: TicketDefinition;
|
|
602
603
|
}
|
|
603
|
-
interface TicketDefinitionSaleEnded {
|
|
604
|
+
export interface TicketDefinitionSaleEnded {
|
|
604
605
|
/** Ticket definition. */
|
|
605
606
|
ticketDefinition?: TicketDefinition;
|
|
606
607
|
}
|
|
607
|
-
interface CreateTicketDefinitionRequest {
|
|
608
|
+
export interface CreateTicketDefinitionRequest {
|
|
608
609
|
/** Ticket definition info. */
|
|
609
610
|
ticketDefinition: TicketDefinition;
|
|
610
611
|
/**
|
|
@@ -613,7 +614,7 @@ interface CreateTicketDefinitionRequest {
|
|
|
613
614
|
*/
|
|
614
615
|
fields?: Field[];
|
|
615
616
|
}
|
|
616
|
-
declare enum Field {
|
|
617
|
+
export declare enum Field {
|
|
617
618
|
/** Unknown requested field. */
|
|
618
619
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
619
620
|
/** Returns `salesDetails` in the response. */
|
|
@@ -621,11 +622,11 @@ declare enum Field {
|
|
|
621
622
|
/** Returns `eventDetails` in the response. */
|
|
622
623
|
EVENT_DETAILS = "EVENT_DETAILS"
|
|
623
624
|
}
|
|
624
|
-
interface CreateTicketDefinitionResponse {
|
|
625
|
+
export interface CreateTicketDefinitionResponse {
|
|
625
626
|
/** Created ticket definition. */
|
|
626
627
|
ticketDefinition?: TicketDefinition;
|
|
627
628
|
}
|
|
628
|
-
interface UpdateTicketDefinitionRequest {
|
|
629
|
+
export interface UpdateTicketDefinitionRequest {
|
|
629
630
|
/** Ticket definition to update. */
|
|
630
631
|
ticketDefinition: TicketDefinition;
|
|
631
632
|
/**
|
|
@@ -634,11 +635,11 @@ interface UpdateTicketDefinitionRequest {
|
|
|
634
635
|
*/
|
|
635
636
|
fields?: Field[];
|
|
636
637
|
}
|
|
637
|
-
interface UpdateTicketDefinitionResponse {
|
|
638
|
+
export interface UpdateTicketDefinitionResponse {
|
|
638
639
|
/** The updated ticket definition. */
|
|
639
640
|
ticketDefinition?: TicketDefinition;
|
|
640
641
|
}
|
|
641
|
-
interface GetTicketDefinitionRequest {
|
|
642
|
+
export interface GetTicketDefinitionRequest {
|
|
642
643
|
/**
|
|
643
644
|
* Ticket definition ID.
|
|
644
645
|
* @format GUID
|
|
@@ -650,20 +651,20 @@ interface GetTicketDefinitionRequest {
|
|
|
650
651
|
*/
|
|
651
652
|
fields?: Field[];
|
|
652
653
|
}
|
|
653
|
-
interface GetTicketDefinitionResponse {
|
|
654
|
+
export interface GetTicketDefinitionResponse {
|
|
654
655
|
/** The requested ticket definition. */
|
|
655
656
|
ticketDefinition?: TicketDefinition;
|
|
656
657
|
}
|
|
657
|
-
interface DeleteTicketDefinitionRequest {
|
|
658
|
+
export interface DeleteTicketDefinitionRequest {
|
|
658
659
|
/**
|
|
659
660
|
* ID of the ticket definition to delete.
|
|
660
661
|
* @format GUID
|
|
661
662
|
*/
|
|
662
663
|
ticketDefinitionId: string;
|
|
663
664
|
}
|
|
664
|
-
interface DeleteTicketDefinitionResponse {
|
|
665
|
+
export interface DeleteTicketDefinitionResponse {
|
|
665
666
|
}
|
|
666
|
-
interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
667
|
+
export interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
667
668
|
/**
|
|
668
669
|
* Move the given `definitionId` before the referenced ticket definition.
|
|
669
670
|
* @format GUID
|
|
@@ -686,7 +687,7 @@ interface ReorderTicketDefinitionsRequest extends ReorderTicketDefinitionsReques
|
|
|
686
687
|
ticketDefinitionId: string;
|
|
687
688
|
}
|
|
688
689
|
/** @oneof */
|
|
689
|
-
interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
690
|
+
export interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
690
691
|
/**
|
|
691
692
|
* Move the given `definitionId` before the referenced ticket definition.
|
|
692
693
|
* @format GUID
|
|
@@ -698,9 +699,9 @@ interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf {
|
|
|
698
699
|
*/
|
|
699
700
|
afterDefinitionId?: string;
|
|
700
701
|
}
|
|
701
|
-
interface ReorderTicketDefinitionsResponse {
|
|
702
|
+
export interface ReorderTicketDefinitionsResponse {
|
|
702
703
|
}
|
|
703
|
-
interface UpdateTicketDefinitionSortIndexRequest {
|
|
704
|
+
export interface UpdateTicketDefinitionSortIndexRequest {
|
|
704
705
|
/**
|
|
705
706
|
* Ticket definition ID
|
|
706
707
|
* @format GUID
|
|
@@ -716,11 +717,11 @@ interface UpdateTicketDefinitionSortIndexRequest {
|
|
|
716
717
|
*/
|
|
717
718
|
fields?: Field[];
|
|
718
719
|
}
|
|
719
|
-
interface UpdateTicketDefinitionSortIndexResponse {
|
|
720
|
+
export interface UpdateTicketDefinitionSortIndexResponse {
|
|
720
721
|
/** the updated ticket definition */
|
|
721
722
|
ticketDefinition?: TicketDefinition;
|
|
722
723
|
}
|
|
723
|
-
interface QueryTicketDefinitionsRequest {
|
|
724
|
+
export interface QueryTicketDefinitionsRequest {
|
|
724
725
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
725
726
|
query: QueryV2;
|
|
726
727
|
/**
|
|
@@ -729,7 +730,7 @@ interface QueryTicketDefinitionsRequest {
|
|
|
729
730
|
*/
|
|
730
731
|
fields?: Field[];
|
|
731
732
|
}
|
|
732
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
733
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
733
734
|
/** Paging options to limit and skip the number of items. */
|
|
734
735
|
paging?: Paging;
|
|
735
736
|
/** 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. */
|
|
@@ -743,13 +744,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
743
744
|
sort?: Sorting[];
|
|
744
745
|
}
|
|
745
746
|
/** @oneof */
|
|
746
|
-
interface QueryV2PagingMethodOneOf {
|
|
747
|
+
export interface QueryV2PagingMethodOneOf {
|
|
747
748
|
/** Paging options to limit and skip the number of items. */
|
|
748
749
|
paging?: Paging;
|
|
749
750
|
/** 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. */
|
|
750
751
|
cursorPaging?: CursorPaging;
|
|
751
752
|
}
|
|
752
|
-
interface Sorting {
|
|
753
|
+
export interface Sorting {
|
|
753
754
|
/**
|
|
754
755
|
* Name of the field to sort by.
|
|
755
756
|
* @maxLength 100
|
|
@@ -758,17 +759,17 @@ interface Sorting {
|
|
|
758
759
|
/** Defaults to `ASC` */
|
|
759
760
|
order?: SortOrder;
|
|
760
761
|
}
|
|
761
|
-
declare enum SortOrder {
|
|
762
|
+
export declare enum SortOrder {
|
|
762
763
|
ASC = "ASC",
|
|
763
764
|
DESC = "DESC"
|
|
764
765
|
}
|
|
765
|
-
interface Paging {
|
|
766
|
+
export interface Paging {
|
|
766
767
|
/** Number of items to load per page. */
|
|
767
768
|
limit?: number | null;
|
|
768
769
|
/** Number of items to skip in the current sort order. */
|
|
769
770
|
offset?: number | null;
|
|
770
771
|
}
|
|
771
|
-
interface CursorPaging {
|
|
772
|
+
export interface CursorPaging {
|
|
772
773
|
/**
|
|
773
774
|
* Number of items to load per page.
|
|
774
775
|
* @max 100
|
|
@@ -783,13 +784,13 @@ interface CursorPaging {
|
|
|
783
784
|
*/
|
|
784
785
|
cursor?: string | null;
|
|
785
786
|
}
|
|
786
|
-
interface QueryTicketDefinitionsResponse {
|
|
787
|
+
export interface QueryTicketDefinitionsResponse {
|
|
787
788
|
/** List of ticket definitions. */
|
|
788
789
|
ticketDefinitions?: TicketDefinition[];
|
|
789
790
|
/** Metadata for the paginated results. */
|
|
790
791
|
metadata?: PagingMetadataV2;
|
|
791
792
|
}
|
|
792
|
-
interface PagingMetadataV2 {
|
|
793
|
+
export interface PagingMetadataV2 {
|
|
793
794
|
/** Number of items returned in the response. */
|
|
794
795
|
count?: number | null;
|
|
795
796
|
/** Offset that was requested. */
|
|
@@ -801,7 +802,7 @@ interface PagingMetadataV2 {
|
|
|
801
802
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
802
803
|
cursors?: Cursors;
|
|
803
804
|
}
|
|
804
|
-
interface Cursors {
|
|
805
|
+
export interface Cursors {
|
|
805
806
|
/**
|
|
806
807
|
* Cursor pointing to next page in the list of results.
|
|
807
808
|
* @maxLength 36
|
|
@@ -813,7 +814,7 @@ interface Cursors {
|
|
|
813
814
|
*/
|
|
814
815
|
prev?: string | null;
|
|
815
816
|
}
|
|
816
|
-
interface QueryAvailableTicketDefinitionsRequest {
|
|
817
|
+
export interface QueryAvailableTicketDefinitionsRequest {
|
|
817
818
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
818
819
|
query: QueryV2;
|
|
819
820
|
/**
|
|
@@ -822,13 +823,13 @@ interface QueryAvailableTicketDefinitionsRequest {
|
|
|
822
823
|
*/
|
|
823
824
|
fields?: Field[];
|
|
824
825
|
}
|
|
825
|
-
interface QueryAvailableTicketDefinitionsResponse {
|
|
826
|
+
export interface QueryAvailableTicketDefinitionsResponse {
|
|
826
827
|
/** List of ticket definitions. */
|
|
827
828
|
ticketDefinitions?: TicketDefinition[];
|
|
828
829
|
/** Metadata for the paginated results. */
|
|
829
830
|
metadata?: PagingMetadataV2;
|
|
830
831
|
}
|
|
831
|
-
interface CountTicketDefinitionsRequest {
|
|
832
|
+
export interface CountTicketDefinitionsRequest {
|
|
832
833
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
833
834
|
filter?: Record<string, any> | null;
|
|
834
835
|
/**
|
|
@@ -840,31 +841,31 @@ interface CountTicketDefinitionsRequest {
|
|
|
840
841
|
*/
|
|
841
842
|
facet?: string[];
|
|
842
843
|
}
|
|
843
|
-
interface CountTicketDefinitionsResponse {
|
|
844
|
+
export interface CountTicketDefinitionsResponse {
|
|
844
845
|
/** Metadata for the paginated results. */
|
|
845
846
|
metadata?: PagingMetadataV2;
|
|
846
847
|
/** Filter facets. */
|
|
847
848
|
facets?: Record<string, FacetCounts>;
|
|
848
849
|
}
|
|
849
|
-
interface FacetCounts {
|
|
850
|
+
export interface FacetCounts {
|
|
850
851
|
/** Facet counts aggregated per value */
|
|
851
852
|
counts?: Record<string, number>;
|
|
852
853
|
}
|
|
853
|
-
interface CountAvailableTicketDefinitionsRequest {
|
|
854
|
+
export interface CountAvailableTicketDefinitionsRequest {
|
|
854
855
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
855
856
|
filter?: Record<string, any> | null;
|
|
856
857
|
}
|
|
857
|
-
interface CountAvailableTicketDefinitionsResponse {
|
|
858
|
+
export interface CountAvailableTicketDefinitionsResponse {
|
|
858
859
|
/** Metadata for the paginated results. */
|
|
859
860
|
metadata?: PagingMetadataV2;
|
|
860
861
|
}
|
|
861
|
-
interface BulkDeleteTicketDefinitionsByFilterRequest {
|
|
862
|
+
export interface BulkDeleteTicketDefinitionsByFilterRequest {
|
|
862
863
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }` */
|
|
863
864
|
filter: Record<string, any> | null;
|
|
864
865
|
}
|
|
865
|
-
interface BulkDeleteTicketDefinitionsByFilterResponse {
|
|
866
|
+
export interface BulkDeleteTicketDefinitionsByFilterResponse {
|
|
866
867
|
}
|
|
867
|
-
interface ChangeCurrencyRequest {
|
|
868
|
+
export interface ChangeCurrencyRequest {
|
|
868
869
|
/**
|
|
869
870
|
* Event ID.
|
|
870
871
|
* @format GUID
|
|
@@ -877,9 +878,9 @@ interface ChangeCurrencyRequest {
|
|
|
877
878
|
*/
|
|
878
879
|
currency: string;
|
|
879
880
|
}
|
|
880
|
-
interface ChangeCurrencyResponse {
|
|
881
|
+
export interface ChangeCurrencyResponse {
|
|
881
882
|
}
|
|
882
|
-
interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
883
|
+
export interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
883
884
|
/**
|
|
884
885
|
* Origin instance ID.
|
|
885
886
|
* @format GUID
|
|
@@ -896,11 +897,11 @@ interface BulkCopyTicketDefinitionsByEventIdRequest {
|
|
|
896
897
|
*/
|
|
897
898
|
targetEventId?: string;
|
|
898
899
|
}
|
|
899
|
-
interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
900
|
+
export interface BulkCopyTicketDefinitionsByEventIdResponse {
|
|
900
901
|
/** Copied ticket definitions. */
|
|
901
902
|
definitions?: CopiedTicketDefinition[];
|
|
902
903
|
}
|
|
903
|
-
interface CopiedTicketDefinition {
|
|
904
|
+
export interface CopiedTicketDefinition {
|
|
904
905
|
/**
|
|
905
906
|
* Origin Ticket definition ID.
|
|
906
907
|
* @format GUID
|
|
@@ -912,13 +913,13 @@ interface CopiedTicketDefinition {
|
|
|
912
913
|
*/
|
|
913
914
|
ticketDefinitionId?: string;
|
|
914
915
|
}
|
|
915
|
-
interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
916
|
+
export interface UpdateFeeTypesBasedOnSettingsRequest {
|
|
916
917
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
917
918
|
query?: QueryV2;
|
|
918
919
|
}
|
|
919
|
-
interface UpdateFeeTypesBasedOnSettingsResponse {
|
|
920
|
+
export interface UpdateFeeTypesBasedOnSettingsResponse {
|
|
920
921
|
}
|
|
921
|
-
interface EventDeleted {
|
|
922
|
+
export interface EventDeleted {
|
|
922
923
|
/** Event deleted timestamp in ISO UTC format. */
|
|
923
924
|
timestamp?: Date | null;
|
|
924
925
|
/**
|
|
@@ -934,9 +935,9 @@ interface EventDeleted {
|
|
|
934
935
|
*/
|
|
935
936
|
userId?: string | null;
|
|
936
937
|
}
|
|
937
|
-
interface Empty {
|
|
938
|
+
export interface Empty {
|
|
938
939
|
}
|
|
939
|
-
interface EventCanceled {
|
|
940
|
+
export interface EventCanceled {
|
|
940
941
|
/** Event canceled timestamp in ISO UTC format. */
|
|
941
942
|
timestamp?: Date | null;
|
|
942
943
|
/**
|
|
@@ -954,7 +955,7 @@ interface EventCanceled {
|
|
|
954
955
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
955
956
|
hasGuests?: boolean | null;
|
|
956
957
|
}
|
|
957
|
-
interface EventEnded {
|
|
958
|
+
export interface EventEnded {
|
|
958
959
|
/** Event end timestamp in ISO UTC format. */
|
|
959
960
|
timestamp?: Date | null;
|
|
960
961
|
/**
|
|
@@ -965,7 +966,7 @@ interface EventEnded {
|
|
|
965
966
|
/** True if at least one guest is registered to the event with any attendance status. */
|
|
966
967
|
hasGuests?: boolean | null;
|
|
967
968
|
}
|
|
968
|
-
interface EventCreated {
|
|
969
|
+
export interface EventCreated {
|
|
969
970
|
/** Event created timestamp in ISO UTC format. */
|
|
970
971
|
timestamp?: Date | null;
|
|
971
972
|
/**
|
|
@@ -999,7 +1000,7 @@ interface EventCreated {
|
|
|
999
1000
|
/** Event that was created. */
|
|
1000
1001
|
event?: Event;
|
|
1001
1002
|
}
|
|
1002
|
-
interface EventsLocation {
|
|
1003
|
+
export interface EventsLocation {
|
|
1003
1004
|
/**
|
|
1004
1005
|
* Location name.
|
|
1005
1006
|
* @maxLength 50
|
|
@@ -1031,7 +1032,7 @@ interface EventsLocation {
|
|
|
1031
1032
|
*/
|
|
1032
1033
|
tbd?: boolean | null;
|
|
1033
1034
|
}
|
|
1034
|
-
interface MapCoordinates {
|
|
1035
|
+
export interface MapCoordinates {
|
|
1035
1036
|
/**
|
|
1036
1037
|
* Latitude.
|
|
1037
1038
|
* @min -90
|
|
@@ -1045,12 +1046,12 @@ interface MapCoordinates {
|
|
|
1045
1046
|
*/
|
|
1046
1047
|
lng?: number;
|
|
1047
1048
|
}
|
|
1048
|
-
declare enum LocationLocationType {
|
|
1049
|
+
export declare enum LocationLocationType {
|
|
1049
1050
|
VENUE = "VENUE",
|
|
1050
1051
|
ONLINE = "ONLINE"
|
|
1051
1052
|
}
|
|
1052
1053
|
/** Physical address */
|
|
1053
|
-
interface Address extends AddressStreetOneOf {
|
|
1054
|
+
export interface Address extends AddressStreetOneOf {
|
|
1054
1055
|
/** a break down of the street to number and street name */
|
|
1055
1056
|
streetAddress?: StreetAddress;
|
|
1056
1057
|
/** Main address line (usually street and number) as free text */
|
|
@@ -1081,19 +1082,19 @@ interface Address extends AddressStreetOneOf {
|
|
|
1081
1082
|
subdivisions?: Subdivision[];
|
|
1082
1083
|
}
|
|
1083
1084
|
/** @oneof */
|
|
1084
|
-
interface AddressStreetOneOf {
|
|
1085
|
+
export interface AddressStreetOneOf {
|
|
1085
1086
|
/** a break down of the street to number and street name */
|
|
1086
1087
|
streetAddress?: StreetAddress;
|
|
1087
1088
|
/** Main address line (usually street and number) as free text */
|
|
1088
1089
|
addressLine?: string | null;
|
|
1089
1090
|
}
|
|
1090
|
-
interface StreetAddress {
|
|
1091
|
+
export interface StreetAddress {
|
|
1091
1092
|
/** street number */
|
|
1092
1093
|
number?: string;
|
|
1093
1094
|
/** street name */
|
|
1094
1095
|
name?: string;
|
|
1095
1096
|
}
|
|
1096
|
-
interface AddressLocation {
|
|
1097
|
+
export interface AddressLocation {
|
|
1097
1098
|
/**
|
|
1098
1099
|
* address latitude coordinates
|
|
1099
1100
|
* @min -90
|
|
@@ -1107,13 +1108,13 @@ interface AddressLocation {
|
|
|
1107
1108
|
*/
|
|
1108
1109
|
longitude?: number | null;
|
|
1109
1110
|
}
|
|
1110
|
-
interface Subdivision {
|
|
1111
|
+
export interface Subdivision {
|
|
1111
1112
|
/** subdivision short code */
|
|
1112
1113
|
code?: string;
|
|
1113
1114
|
/** subdivision full-name */
|
|
1114
1115
|
name?: string;
|
|
1115
1116
|
}
|
|
1116
|
-
declare enum SubdivisionType {
|
|
1117
|
+
export declare enum SubdivisionType {
|
|
1117
1118
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
1118
1119
|
/** State */
|
|
1119
1120
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -1128,7 +1129,7 @@ declare enum SubdivisionType {
|
|
|
1128
1129
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
1129
1130
|
COUNTRY = "COUNTRY"
|
|
1130
1131
|
}
|
|
1131
|
-
interface ScheduleConfig {
|
|
1132
|
+
export interface ScheduleConfig {
|
|
1132
1133
|
/**
|
|
1133
1134
|
* Defines event as TBD (To Be Determined) schedule.
|
|
1134
1135
|
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
@@ -1156,7 +1157,7 @@ interface ScheduleConfig {
|
|
|
1156
1157
|
/** Event recurrences. */
|
|
1157
1158
|
recurrences?: EventsRecurrences;
|
|
1158
1159
|
}
|
|
1159
|
-
interface EventsRecurrences {
|
|
1160
|
+
export interface EventsRecurrences {
|
|
1160
1161
|
/**
|
|
1161
1162
|
* Event occurrences.
|
|
1162
1163
|
* @maxSize 1000
|
|
@@ -1173,7 +1174,7 @@ interface EventsRecurrences {
|
|
|
1173
1174
|
*/
|
|
1174
1175
|
status?: EventsRecurrenceStatusStatus;
|
|
1175
1176
|
}
|
|
1176
|
-
interface EventsOccurrence {
|
|
1177
|
+
export interface EventsOccurrence {
|
|
1177
1178
|
/** Event start timestamp. */
|
|
1178
1179
|
startDate?: Date | null;
|
|
1179
1180
|
/** Event end timestamp. */
|
|
@@ -1186,7 +1187,7 @@ interface EventsOccurrence {
|
|
|
1186
1187
|
/** Whether time zone is displayed in formatted schedule. */
|
|
1187
1188
|
showTimeZone?: boolean;
|
|
1188
1189
|
}
|
|
1189
|
-
declare enum EventsRecurrenceStatusStatus {
|
|
1190
|
+
export declare enum EventsRecurrenceStatusStatus {
|
|
1190
1191
|
/** Event occurs only once. */
|
|
1191
1192
|
ONE_TIME = "ONE_TIME",
|
|
1192
1193
|
/** Event is recurring. */
|
|
@@ -1198,7 +1199,7 @@ declare enum EventsRecurrenceStatusStatus {
|
|
|
1198
1199
|
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
1199
1200
|
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
1200
1201
|
}
|
|
1201
|
-
declare enum EventStatus {
|
|
1202
|
+
export declare enum EventStatus {
|
|
1202
1203
|
/** Event is public and scheduled to start */
|
|
1203
1204
|
SCHEDULED = "SCHEDULED",
|
|
1204
1205
|
/** Event has started */
|
|
@@ -1208,7 +1209,7 @@ declare enum EventStatus {
|
|
|
1208
1209
|
/** Event was canceled */
|
|
1209
1210
|
CANCELED = "CANCELED"
|
|
1210
1211
|
}
|
|
1211
|
-
interface Event {
|
|
1212
|
+
export interface Event {
|
|
1212
1213
|
/**
|
|
1213
1214
|
* Event ID.
|
|
1214
1215
|
* @format GUID
|
|
@@ -1278,7 +1279,7 @@ interface Event {
|
|
|
1278
1279
|
*/
|
|
1279
1280
|
publishedDate?: Date | null;
|
|
1280
1281
|
}
|
|
1281
|
-
interface Scheduling {
|
|
1282
|
+
export interface Scheduling {
|
|
1282
1283
|
/** Schedule configuration. */
|
|
1283
1284
|
config?: ScheduleConfig;
|
|
1284
1285
|
/** Formatted schedule representation. */
|
|
@@ -1292,7 +1293,7 @@ interface Scheduling {
|
|
|
1292
1293
|
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
1293
1294
|
endTimeFormatted?: string;
|
|
1294
1295
|
}
|
|
1295
|
-
interface Registration {
|
|
1296
|
+
export interface Registration {
|
|
1296
1297
|
/** Event type. */
|
|
1297
1298
|
type?: EventType;
|
|
1298
1299
|
/** Event registration status. */
|
|
@@ -1308,7 +1309,7 @@ interface Registration {
|
|
|
1308
1309
|
/** Initial event type which was set when creating an event. */
|
|
1309
1310
|
initialType?: EventType;
|
|
1310
1311
|
}
|
|
1311
|
-
declare enum EventType {
|
|
1312
|
+
export declare enum EventType {
|
|
1312
1313
|
/** Type not available for this request fieldset */
|
|
1313
1314
|
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
1314
1315
|
/** Registration via RSVP */
|
|
@@ -1320,7 +1321,7 @@ declare enum EventType {
|
|
|
1320
1321
|
/** Registration not available */
|
|
1321
1322
|
NO_REGISTRATION = "NO_REGISTRATION"
|
|
1322
1323
|
}
|
|
1323
|
-
declare enum RegistrationStatus {
|
|
1324
|
+
export declare enum RegistrationStatus {
|
|
1324
1325
|
/** Registration status is not applicable */
|
|
1325
1326
|
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
1326
1327
|
/** Registration to event is closed */
|
|
@@ -1338,11 +1339,11 @@ declare enum RegistrationStatus {
|
|
|
1338
1339
|
/** Registration will be open via RSVP */
|
|
1339
1340
|
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
1340
1341
|
}
|
|
1341
|
-
interface RsvpCollection {
|
|
1342
|
+
export interface RsvpCollection {
|
|
1342
1343
|
/** RSVP collection configuration. */
|
|
1343
1344
|
config?: RsvpCollectionConfig;
|
|
1344
1345
|
}
|
|
1345
|
-
interface RsvpCollectionConfig {
|
|
1346
|
+
export interface RsvpCollectionConfig {
|
|
1346
1347
|
/** Defines the supported RSVP statuses. */
|
|
1347
1348
|
rsvpStatusOptions?: RsvpStatusOptions;
|
|
1348
1349
|
/**
|
|
@@ -1357,13 +1358,13 @@ interface RsvpCollectionConfig {
|
|
|
1357
1358
|
/** Registration end timestamp. */
|
|
1358
1359
|
endDate?: Date | null;
|
|
1359
1360
|
}
|
|
1360
|
-
declare enum RsvpStatusOptions {
|
|
1361
|
+
export declare enum RsvpStatusOptions {
|
|
1361
1362
|
/** Only YES RSVP status is available for RSVP registration */
|
|
1362
1363
|
YES_ONLY = "YES_ONLY",
|
|
1363
1364
|
/** YES and NO RSVP status options are available for the registration */
|
|
1364
1365
|
YES_AND_NO = "YES_AND_NO"
|
|
1365
1366
|
}
|
|
1366
|
-
interface Ticketing {
|
|
1367
|
+
export interface Ticketing {
|
|
1367
1368
|
/**
|
|
1368
1369
|
* Deprecated.
|
|
1369
1370
|
* @deprecated
|
|
@@ -1404,7 +1405,7 @@ interface Ticketing {
|
|
|
1404
1405
|
*/
|
|
1405
1406
|
soldOut?: boolean | null;
|
|
1406
1407
|
}
|
|
1407
|
-
interface TicketingConfig {
|
|
1408
|
+
export interface TicketingConfig {
|
|
1408
1409
|
/** Whether the form must be filled out separately for each ticket. */
|
|
1409
1410
|
guestAssignedTickets?: boolean;
|
|
1410
1411
|
/** Tax configuration. */
|
|
@@ -1421,7 +1422,7 @@ interface TicketingConfig {
|
|
|
1421
1422
|
*/
|
|
1422
1423
|
reservationDurationInMinutes?: number | null;
|
|
1423
1424
|
}
|
|
1424
|
-
interface TaxConfig {
|
|
1425
|
+
export interface TaxConfig {
|
|
1425
1426
|
/** Tax application settings. */
|
|
1426
1427
|
type?: TaxType;
|
|
1427
1428
|
/**
|
|
@@ -1438,7 +1439,7 @@ interface TaxConfig {
|
|
|
1438
1439
|
/** Applies taxes for donations, default true. */
|
|
1439
1440
|
appliesToDonations?: boolean | null;
|
|
1440
1441
|
}
|
|
1441
|
-
declare enum TaxType {
|
|
1442
|
+
export declare enum TaxType {
|
|
1442
1443
|
/** Tax is included in the ticket price. */
|
|
1443
1444
|
INCLUDED = "INCLUDED",
|
|
1444
1445
|
/** Tax is added to the order at the checkout. */
|
|
@@ -1446,7 +1447,7 @@ declare enum TaxType {
|
|
|
1446
1447
|
/** Tax is added to the final total at the checkout. */
|
|
1447
1448
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
1448
1449
|
}
|
|
1449
|
-
interface Money {
|
|
1450
|
+
export interface Money {
|
|
1450
1451
|
/**
|
|
1451
1452
|
* *Deprecated:** Use `value` instead.
|
|
1452
1453
|
* @format DECIMAL_VALUE
|
|
@@ -1464,11 +1465,11 @@ interface Money {
|
|
|
1464
1465
|
*/
|
|
1465
1466
|
value?: string | null;
|
|
1466
1467
|
}
|
|
1467
|
-
interface ExternalEvent {
|
|
1468
|
+
export interface ExternalEvent {
|
|
1468
1469
|
/** External event registration URL. */
|
|
1469
1470
|
registration?: string;
|
|
1470
1471
|
}
|
|
1471
|
-
declare enum VisitorType {
|
|
1472
|
+
export declare enum VisitorType {
|
|
1472
1473
|
/** Site visitor (including member) */
|
|
1473
1474
|
VISITOR = "VISITOR",
|
|
1474
1475
|
/** Site member */
|
|
@@ -1476,14 +1477,14 @@ declare enum VisitorType {
|
|
|
1476
1477
|
/** Site visitor or member */
|
|
1477
1478
|
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
1478
1479
|
}
|
|
1479
|
-
interface CalendarLinks {
|
|
1480
|
+
export interface CalendarLinks {
|
|
1480
1481
|
/** "Add to Google calendar" URL. */
|
|
1481
1482
|
google?: string;
|
|
1482
1483
|
/** "Download ICS calendar file" URL. */
|
|
1483
1484
|
ics?: string;
|
|
1484
1485
|
}
|
|
1485
1486
|
/** Site URL components */
|
|
1486
|
-
interface SiteUrl {
|
|
1487
|
+
export interface SiteUrl {
|
|
1487
1488
|
/**
|
|
1488
1489
|
* Base URL. For premium sites, this will be the domain.
|
|
1489
1490
|
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
@@ -1505,7 +1506,7 @@ interface SiteUrl {
|
|
|
1505
1506
|
*
|
|
1506
1507
|
* By default, name and email controls are always required and are pinned to the top of the form.
|
|
1507
1508
|
*/
|
|
1508
|
-
interface Form {
|
|
1509
|
+
export interface Form {
|
|
1509
1510
|
/** Nested fields as an ordered list. */
|
|
1510
1511
|
controls?: InputControl[];
|
|
1511
1512
|
/** Set of configured form messages. */
|
|
@@ -1515,7 +1516,7 @@ interface Form {
|
|
|
1515
1516
|
* A block of nested fields.
|
|
1516
1517
|
* Used to aggregate similar inputs like First Name and Last Name.
|
|
1517
1518
|
*/
|
|
1518
|
-
interface InputControl {
|
|
1519
|
+
export interface InputControl {
|
|
1519
1520
|
/** Field control type. */
|
|
1520
1521
|
type?: InputControlType;
|
|
1521
1522
|
/** Whether control is mandatory (such as name & email). When true, only label can be changed. */
|
|
@@ -1542,7 +1543,7 @@ interface InputControl {
|
|
|
1542
1543
|
*/
|
|
1543
1544
|
deleted?: boolean | null;
|
|
1544
1545
|
}
|
|
1545
|
-
declare enum InputControlType {
|
|
1546
|
+
export declare enum InputControlType {
|
|
1546
1547
|
/** Single text value field. */
|
|
1547
1548
|
INPUT = "INPUT",
|
|
1548
1549
|
/** Single text value field. */
|
|
@@ -1565,7 +1566,7 @@ declare enum InputControlType {
|
|
|
1565
1566
|
DATE = "DATE"
|
|
1566
1567
|
}
|
|
1567
1568
|
/** An input of one or multiple text values */
|
|
1568
|
-
interface Input {
|
|
1569
|
+
export interface Input {
|
|
1569
1570
|
/** Field name. */
|
|
1570
1571
|
name?: string;
|
|
1571
1572
|
/**
|
|
@@ -1604,7 +1605,7 @@ interface Input {
|
|
|
1604
1605
|
*/
|
|
1605
1606
|
labels?: Label[];
|
|
1606
1607
|
}
|
|
1607
|
-
declare enum ValueType {
|
|
1608
|
+
export declare enum ValueType {
|
|
1608
1609
|
TEXT = "TEXT",
|
|
1609
1610
|
NUMBER = "NUMBER",
|
|
1610
1611
|
TEXT_ARRAY = "TEXT_ARRAY",
|
|
@@ -1615,7 +1616,7 @@ declare enum ValueType {
|
|
|
1615
1616
|
* Describes initially selected option when an input has multiple choices.
|
|
1616
1617
|
* Defaults to first (0th) option if not configured.
|
|
1617
1618
|
*/
|
|
1618
|
-
interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1619
|
+
export interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
1619
1620
|
/**
|
|
1620
1621
|
* 0-based index from predefined `input.options` which is selected initially.
|
|
1621
1622
|
* @max 199
|
|
@@ -1629,7 +1630,7 @@ interface OptionSelection extends OptionSelectionSelectedOptionOneOf {
|
|
|
1629
1630
|
placeholderText?: string;
|
|
1630
1631
|
}
|
|
1631
1632
|
/** @oneof */
|
|
1632
|
-
interface OptionSelectionSelectedOptionOneOf {
|
|
1633
|
+
export interface OptionSelectionSelectedOptionOneOf {
|
|
1633
1634
|
/**
|
|
1634
1635
|
* 0-based index from predefined `input.options` which is selected initially.
|
|
1635
1636
|
* @max 199
|
|
@@ -1642,7 +1643,7 @@ interface OptionSelectionSelectedOptionOneOf {
|
|
|
1642
1643
|
*/
|
|
1643
1644
|
placeholderText?: string;
|
|
1644
1645
|
}
|
|
1645
|
-
interface Label {
|
|
1646
|
+
export interface Label {
|
|
1646
1647
|
/** Field name. */
|
|
1647
1648
|
name?: string;
|
|
1648
1649
|
/** Field label. */
|
|
@@ -1652,7 +1653,7 @@ interface Label {
|
|
|
1652
1653
|
* Defines form messages shown in UI before, during, and after registration flow.
|
|
1653
1654
|
* It enables configuration of form titles, response labels, "thank you" messages, and call-to-action texts.
|
|
1654
1655
|
*/
|
|
1655
|
-
interface FormMessages {
|
|
1656
|
+
export interface FormMessages {
|
|
1656
1657
|
/** RSVP form messages. */
|
|
1657
1658
|
rsvp?: RsvpFormMessages;
|
|
1658
1659
|
/** Checkout form messages. */
|
|
@@ -1662,7 +1663,7 @@ interface FormMessages {
|
|
|
1662
1663
|
/** Messages shown when event tickets are unavailable. */
|
|
1663
1664
|
ticketsUnavailable?: TicketsUnavailableMessages;
|
|
1664
1665
|
}
|
|
1665
|
-
interface RsvpFormMessages {
|
|
1666
|
+
export interface RsvpFormMessages {
|
|
1666
1667
|
/** Label text indicating RSVP `YES` response. */
|
|
1667
1668
|
rsvpYesOption?: string;
|
|
1668
1669
|
/** Label text indicating RSVP `NO` response. */
|
|
@@ -1677,7 +1678,7 @@ interface RsvpFormMessages {
|
|
|
1677
1678
|
submitActionLabel?: string;
|
|
1678
1679
|
}
|
|
1679
1680
|
/** Confirmation messages shown after registration. */
|
|
1680
|
-
interface PositiveResponseConfirmation {
|
|
1681
|
+
export interface PositiveResponseConfirmation {
|
|
1681
1682
|
/** Confirmation message title. */
|
|
1682
1683
|
title?: string;
|
|
1683
1684
|
/** Confirmation message text. */
|
|
@@ -1688,27 +1689,27 @@ interface PositiveResponseConfirmation {
|
|
|
1688
1689
|
shareActionLabel?: string;
|
|
1689
1690
|
}
|
|
1690
1691
|
/** Confirmation messages shown after registration. */
|
|
1691
|
-
interface NegativeResponseConfirmation {
|
|
1692
|
+
export interface NegativeResponseConfirmation {
|
|
1692
1693
|
/** Confirmation message title. */
|
|
1693
1694
|
title?: string;
|
|
1694
1695
|
/** "Share event" call-to-action label text. */
|
|
1695
1696
|
shareActionLabel?: string;
|
|
1696
1697
|
}
|
|
1697
1698
|
/** Set of messages shown during registration when RSVP response is positive. */
|
|
1698
|
-
interface Positive {
|
|
1699
|
+
export interface Positive {
|
|
1699
1700
|
/** Main form title for positive response. */
|
|
1700
1701
|
title?: string;
|
|
1701
1702
|
/** Confirmation messages shown after registration. */
|
|
1702
1703
|
confirmation?: PositiveResponseConfirmation;
|
|
1703
1704
|
}
|
|
1704
1705
|
/** A set of messages shown during registration with negative response */
|
|
1705
|
-
interface Negative {
|
|
1706
|
+
export interface Negative {
|
|
1706
1707
|
/** Main form title for negative response. */
|
|
1707
1708
|
title?: string;
|
|
1708
1709
|
/** Confirmation messages shown after registration. */
|
|
1709
1710
|
confirmation?: NegativeResponseConfirmation;
|
|
1710
1711
|
}
|
|
1711
|
-
interface CheckoutFormMessages {
|
|
1712
|
+
export interface CheckoutFormMessages {
|
|
1712
1713
|
/** Main form title for response. */
|
|
1713
1714
|
title?: string;
|
|
1714
1715
|
/** Submit form call-to-action label text. */
|
|
@@ -1717,7 +1718,7 @@ interface CheckoutFormMessages {
|
|
|
1717
1718
|
confirmation?: ResponseConfirmation;
|
|
1718
1719
|
}
|
|
1719
1720
|
/** Confirmation messages shown after checkout. */
|
|
1720
|
-
interface ResponseConfirmation {
|
|
1721
|
+
export interface ResponseConfirmation {
|
|
1721
1722
|
/** Confirmation message title. */
|
|
1722
1723
|
title?: string;
|
|
1723
1724
|
/** Confirmation message text. */
|
|
@@ -1729,19 +1730,19 @@ interface ResponseConfirmation {
|
|
|
1729
1730
|
/** "Share event" call-to-action label text. */
|
|
1730
1731
|
shareEventLabel?: string;
|
|
1731
1732
|
}
|
|
1732
|
-
interface RegistrationClosedMessages {
|
|
1733
|
+
export interface RegistrationClosedMessages {
|
|
1733
1734
|
/** Message shown when event registration is closed. */
|
|
1734
1735
|
message?: string;
|
|
1735
1736
|
/** "Explore other events" call-to-action label text. */
|
|
1736
1737
|
exploreEventsActionLabel?: string;
|
|
1737
1738
|
}
|
|
1738
|
-
interface TicketsUnavailableMessages {
|
|
1739
|
+
export interface TicketsUnavailableMessages {
|
|
1739
1740
|
/** Message shown when event tickets are unavailable. */
|
|
1740
1741
|
message?: string;
|
|
1741
1742
|
/** "Explore other events" call-to-action label text. */
|
|
1742
1743
|
exploreEventsActionLabel?: string;
|
|
1743
1744
|
}
|
|
1744
|
-
interface Dashboard {
|
|
1745
|
+
export interface Dashboard {
|
|
1745
1746
|
/** Guest RSVP summary. */
|
|
1746
1747
|
rsvpSummary?: RsvpSummary;
|
|
1747
1748
|
/**
|
|
@@ -1750,7 +1751,7 @@ interface Dashboard {
|
|
|
1750
1751
|
*/
|
|
1751
1752
|
ticketingSummary?: TicketingSummary;
|
|
1752
1753
|
}
|
|
1753
|
-
interface RsvpSummary {
|
|
1754
|
+
export interface RsvpSummary {
|
|
1754
1755
|
/** Total number of RSVPs. */
|
|
1755
1756
|
total?: number;
|
|
1756
1757
|
/** Number of RSVPs with status `YES`. */
|
|
@@ -1760,7 +1761,7 @@ interface RsvpSummary {
|
|
|
1760
1761
|
/** Number of RSVPs in waitlist. */
|
|
1761
1762
|
waitlist?: number;
|
|
1762
1763
|
}
|
|
1763
|
-
interface TicketingSummary {
|
|
1764
|
+
export interface TicketingSummary {
|
|
1764
1765
|
/** Number of tickets sold. */
|
|
1765
1766
|
tickets?: number;
|
|
1766
1767
|
/**
|
|
@@ -1775,19 +1776,19 @@ interface TicketingSummary {
|
|
|
1775
1776
|
/** Total balance of confirmed transactions. */
|
|
1776
1777
|
totalSales?: Money;
|
|
1777
1778
|
}
|
|
1778
|
-
interface GuestListConfig {
|
|
1779
|
+
export interface GuestListConfig {
|
|
1779
1780
|
/** Whether members can see other members attending the event (defaults to true). */
|
|
1780
1781
|
publicGuestList?: boolean;
|
|
1781
1782
|
}
|
|
1782
|
-
interface Feed {
|
|
1783
|
+
export interface Feed {
|
|
1783
1784
|
/** Event discussion feed token. */
|
|
1784
1785
|
token?: string;
|
|
1785
1786
|
}
|
|
1786
|
-
interface OnlineConferencing {
|
|
1787
|
+
export interface OnlineConferencing {
|
|
1787
1788
|
config?: OnlineConferencingConfig;
|
|
1788
1789
|
session?: OnlineConferencingSession;
|
|
1789
1790
|
}
|
|
1790
|
-
interface OnlineConferencingConfig {
|
|
1791
|
+
export interface OnlineConferencingConfig {
|
|
1791
1792
|
/**
|
|
1792
1793
|
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
1793
1794
|
* When enabled, links to join conferencing are generated and provided to guests.
|
|
@@ -1801,13 +1802,13 @@ interface OnlineConferencingConfig {
|
|
|
1801
1802
|
/** Conference type */
|
|
1802
1803
|
conferenceType?: ConferenceType;
|
|
1803
1804
|
}
|
|
1804
|
-
declare enum ConferenceType {
|
|
1805
|
+
export declare enum ConferenceType {
|
|
1805
1806
|
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
1806
1807
|
MEETING = "MEETING",
|
|
1807
1808
|
/** Guests can only subscribe to video and audio. */
|
|
1808
1809
|
WEBINAR = "WEBINAR"
|
|
1809
1810
|
}
|
|
1810
|
-
interface OnlineConferencingSession {
|
|
1811
|
+
export interface OnlineConferencingSession {
|
|
1811
1812
|
/**
|
|
1812
1813
|
* Link for event host to start the online conference session.
|
|
1813
1814
|
* @readonly
|
|
@@ -1834,7 +1835,7 @@ interface OnlineConferencingSession {
|
|
|
1834
1835
|
*/
|
|
1835
1836
|
sessionId?: string | null;
|
|
1836
1837
|
}
|
|
1837
|
-
interface SeoSettings {
|
|
1838
|
+
export interface SeoSettings {
|
|
1838
1839
|
/**
|
|
1839
1840
|
* URL slug
|
|
1840
1841
|
* @maxLength 130
|
|
@@ -1853,13 +1854,13 @@ interface SeoSettings {
|
|
|
1853
1854
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
1854
1855
|
* 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.
|
|
1855
1856
|
*/
|
|
1856
|
-
interface SeoSchema {
|
|
1857
|
+
export interface SeoSchema {
|
|
1857
1858
|
/** SEO tag information. */
|
|
1858
1859
|
tags?: Tag[];
|
|
1859
1860
|
/** SEO general settings. */
|
|
1860
1861
|
settings?: Settings;
|
|
1861
1862
|
}
|
|
1862
|
-
interface Keyword {
|
|
1863
|
+
export interface Keyword {
|
|
1863
1864
|
/** Keyword value. */
|
|
1864
1865
|
term?: string;
|
|
1865
1866
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -1870,7 +1871,7 @@ interface Keyword {
|
|
|
1870
1871
|
*/
|
|
1871
1872
|
origin?: string | null;
|
|
1872
1873
|
}
|
|
1873
|
-
interface Tag {
|
|
1874
|
+
export interface Tag {
|
|
1874
1875
|
/**
|
|
1875
1876
|
* SEO tag type.
|
|
1876
1877
|
*
|
|
@@ -1892,7 +1893,7 @@ interface Tag {
|
|
|
1892
1893
|
/** Whether the tag is disabled. */
|
|
1893
1894
|
disabled?: boolean;
|
|
1894
1895
|
}
|
|
1895
|
-
interface Settings {
|
|
1896
|
+
export interface Settings {
|
|
1896
1897
|
/**
|
|
1897
1898
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
1898
1899
|
*
|
|
@@ -1906,7 +1907,7 @@ interface Settings {
|
|
|
1906
1907
|
*/
|
|
1907
1908
|
keywords?: Keyword[];
|
|
1908
1909
|
}
|
|
1909
|
-
interface Agenda {
|
|
1910
|
+
export interface Agenda {
|
|
1910
1911
|
/** Whether the schedule is enabled for the event. */
|
|
1911
1912
|
enabled?: boolean;
|
|
1912
1913
|
/**
|
|
@@ -1915,7 +1916,7 @@ interface Agenda {
|
|
|
1915
1916
|
*/
|
|
1916
1917
|
pageUrl?: SiteUrl;
|
|
1917
1918
|
}
|
|
1918
|
-
interface Category {
|
|
1919
|
+
export interface Category {
|
|
1919
1920
|
/**
|
|
1920
1921
|
* Category ID.
|
|
1921
1922
|
* @format GUID
|
|
@@ -1953,13 +1954,13 @@ interface Category {
|
|
|
1953
1954
|
*/
|
|
1954
1955
|
states?: CategoryStateState[];
|
|
1955
1956
|
}
|
|
1956
|
-
interface CategoryCounts {
|
|
1957
|
+
export interface CategoryCounts {
|
|
1957
1958
|
/** Total number of draft events assigned to the category. */
|
|
1958
1959
|
assignedEventsCount?: number | null;
|
|
1959
1960
|
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
1960
1961
|
assignedDraftEventsCount?: number | null;
|
|
1961
1962
|
}
|
|
1962
|
-
declare enum CategoryStateState {
|
|
1963
|
+
export declare enum CategoryStateState {
|
|
1963
1964
|
/** Created manually by the user. */
|
|
1964
1965
|
MANUAL = "MANUAL",
|
|
1965
1966
|
/** Created automatically. */
|
|
@@ -1969,15 +1970,15 @@ declare enum CategoryStateState {
|
|
|
1969
1970
|
/** Category is hidden. */
|
|
1970
1971
|
HIDDEN = "HIDDEN"
|
|
1971
1972
|
}
|
|
1972
|
-
interface EventDisplaySettings {
|
|
1973
|
+
export interface EventDisplaySettings {
|
|
1973
1974
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1974
1975
|
hideEventDetailsButton?: boolean | null;
|
|
1975
1976
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
1976
1977
|
hideEventDetailsPage?: boolean | null;
|
|
1977
1978
|
}
|
|
1978
|
-
interface LabellingSettings {
|
|
1979
|
+
export interface LabellingSettings {
|
|
1979
1980
|
}
|
|
1980
|
-
interface RichContent {
|
|
1981
|
+
export interface RichContent {
|
|
1981
1982
|
/** Node objects representing a rich content document. */
|
|
1982
1983
|
nodes?: Node[];
|
|
1983
1984
|
/** Object metadata. */
|
|
@@ -1985,7 +1986,7 @@ interface RichContent {
|
|
|
1985
1986
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1986
1987
|
documentStyle?: DocumentStyle;
|
|
1987
1988
|
}
|
|
1988
|
-
interface Node extends NodeDataOneOf {
|
|
1989
|
+
export interface Node extends NodeDataOneOf {
|
|
1989
1990
|
/** Data for a button node. */
|
|
1990
1991
|
buttonData?: ButtonData;
|
|
1991
1992
|
/** Data for a code block node. */
|
|
@@ -2050,7 +2051,7 @@ interface Node extends NodeDataOneOf {
|
|
|
2050
2051
|
style?: NodeStyle;
|
|
2051
2052
|
}
|
|
2052
2053
|
/** @oneof */
|
|
2053
|
-
interface NodeDataOneOf {
|
|
2054
|
+
export interface NodeDataOneOf {
|
|
2054
2055
|
/** Data for a button node. */
|
|
2055
2056
|
buttonData?: ButtonData;
|
|
2056
2057
|
/** Data for a code block node. */
|
|
@@ -2106,7 +2107,7 @@ interface NodeDataOneOf {
|
|
|
2106
2107
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
2107
2108
|
layoutCellData?: LayoutCellData;
|
|
2108
2109
|
}
|
|
2109
|
-
declare enum NodeType {
|
|
2110
|
+
export declare enum NodeType {
|
|
2110
2111
|
PARAGRAPH = "PARAGRAPH",
|
|
2111
2112
|
TEXT = "TEXT",
|
|
2112
2113
|
HEADING = "HEADING",
|
|
@@ -2142,7 +2143,7 @@ declare enum NodeType {
|
|
|
2142
2143
|
LAYOUT = "LAYOUT",
|
|
2143
2144
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
2144
2145
|
}
|
|
2145
|
-
interface NodeStyle {
|
|
2146
|
+
export interface NodeStyle {
|
|
2146
2147
|
/** The top padding value in pixels. */
|
|
2147
2148
|
paddingTop?: string | null;
|
|
2148
2149
|
/** The bottom padding value in pixels. */
|
|
@@ -2150,7 +2151,7 @@ interface NodeStyle {
|
|
|
2150
2151
|
/** The background color as a hexadecimal value. */
|
|
2151
2152
|
backgroundColor?: string | null;
|
|
2152
2153
|
}
|
|
2153
|
-
interface ButtonData {
|
|
2154
|
+
export interface ButtonData {
|
|
2154
2155
|
/** Styling for the button's container. */
|
|
2155
2156
|
containerData?: PluginContainerData;
|
|
2156
2157
|
/** The button type. */
|
|
@@ -2162,13 +2163,13 @@ interface ButtonData {
|
|
|
2162
2163
|
/** Button link details. */
|
|
2163
2164
|
link?: Link;
|
|
2164
2165
|
}
|
|
2165
|
-
interface Border {
|
|
2166
|
+
export interface Border {
|
|
2166
2167
|
/** Border width in pixels. */
|
|
2167
2168
|
width?: number | null;
|
|
2168
2169
|
/** Border radius in pixels. */
|
|
2169
2170
|
radius?: number | null;
|
|
2170
2171
|
}
|
|
2171
|
-
interface Colors {
|
|
2172
|
+
export interface Colors {
|
|
2172
2173
|
/** The text color as a hexadecimal value. */
|
|
2173
2174
|
text?: string | null;
|
|
2174
2175
|
/** The border color as a hexadecimal value. */
|
|
@@ -2176,7 +2177,7 @@ interface Colors {
|
|
|
2176
2177
|
/** The background color as a hexadecimal value. */
|
|
2177
2178
|
background?: string | null;
|
|
2178
2179
|
}
|
|
2179
|
-
interface PluginContainerData {
|
|
2180
|
+
export interface PluginContainerData {
|
|
2180
2181
|
/** The width of the node when it's displayed. */
|
|
2181
2182
|
width?: PluginContainerDataWidth;
|
|
2182
2183
|
/** The node's alignment within its container. */
|
|
@@ -2188,7 +2189,7 @@ interface PluginContainerData {
|
|
|
2188
2189
|
/** 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`. */
|
|
2189
2190
|
textWrap?: boolean | null;
|
|
2190
2191
|
}
|
|
2191
|
-
declare enum WidthType {
|
|
2192
|
+
export declare enum WidthType {
|
|
2192
2193
|
/** Width matches the content width */
|
|
2193
2194
|
CONTENT = "CONTENT",
|
|
2194
2195
|
/** Small Width */
|
|
@@ -2198,7 +2199,7 @@ declare enum WidthType {
|
|
|
2198
2199
|
/** coast-to-coast display */
|
|
2199
2200
|
FULL_WIDTH = "FULL_WIDTH"
|
|
2200
2201
|
}
|
|
2201
|
-
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2202
|
+
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2202
2203
|
/**
|
|
2203
2204
|
* One of the following predefined width options:
|
|
2204
2205
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2211,7 +2212,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
2211
2212
|
custom?: string | null;
|
|
2212
2213
|
}
|
|
2213
2214
|
/** @oneof */
|
|
2214
|
-
interface PluginContainerDataWidthDataOneOf {
|
|
2215
|
+
export interface PluginContainerDataWidthDataOneOf {
|
|
2215
2216
|
/**
|
|
2216
2217
|
* One of the following predefined width options:
|
|
2217
2218
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2223,7 +2224,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
2223
2224
|
/** A custom width value in pixels. */
|
|
2224
2225
|
custom?: string | null;
|
|
2225
2226
|
}
|
|
2226
|
-
declare enum PluginContainerDataAlignment {
|
|
2227
|
+
export declare enum PluginContainerDataAlignment {
|
|
2227
2228
|
/** Center Alignment */
|
|
2228
2229
|
CENTER = "CENTER",
|
|
2229
2230
|
/** Left Alignment */
|
|
@@ -2231,7 +2232,7 @@ declare enum PluginContainerDataAlignment {
|
|
|
2231
2232
|
/** Right Alignment */
|
|
2232
2233
|
RIGHT = "RIGHT"
|
|
2233
2234
|
}
|
|
2234
|
-
interface Spoiler {
|
|
2235
|
+
export interface Spoiler {
|
|
2235
2236
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
2236
2237
|
enabled?: boolean | null;
|
|
2237
2238
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -2239,23 +2240,23 @@ interface Spoiler {
|
|
|
2239
2240
|
/** The text for the button used to remove the spoiler cover. */
|
|
2240
2241
|
buttonText?: string | null;
|
|
2241
2242
|
}
|
|
2242
|
-
interface Height {
|
|
2243
|
+
export interface Height {
|
|
2243
2244
|
/** A custom height value in pixels. */
|
|
2244
2245
|
custom?: string | null;
|
|
2245
2246
|
}
|
|
2246
|
-
declare enum ButtonDataType {
|
|
2247
|
+
export declare enum ButtonDataType {
|
|
2247
2248
|
/** Regular link button */
|
|
2248
2249
|
LINK = "LINK",
|
|
2249
2250
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
2250
2251
|
ACTION = "ACTION"
|
|
2251
2252
|
}
|
|
2252
|
-
interface Styles {
|
|
2253
|
+
export interface Styles {
|
|
2253
2254
|
/** Border attributes. */
|
|
2254
2255
|
border?: Border;
|
|
2255
2256
|
/** Color attributes. */
|
|
2256
2257
|
colors?: Colors;
|
|
2257
2258
|
}
|
|
2258
|
-
interface Link extends LinkDataOneOf {
|
|
2259
|
+
export interface Link extends LinkDataOneOf {
|
|
2259
2260
|
/** The absolute URL for the linked document. */
|
|
2260
2261
|
url?: string;
|
|
2261
2262
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -2274,13 +2275,13 @@ interface Link extends LinkDataOneOf {
|
|
|
2274
2275
|
customData?: string | null;
|
|
2275
2276
|
}
|
|
2276
2277
|
/** @oneof */
|
|
2277
|
-
interface LinkDataOneOf {
|
|
2278
|
+
export interface LinkDataOneOf {
|
|
2278
2279
|
/** The absolute URL for the linked document. */
|
|
2279
2280
|
url?: string;
|
|
2280
2281
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
2281
2282
|
anchor?: string;
|
|
2282
2283
|
}
|
|
2283
|
-
declare enum Target {
|
|
2284
|
+
export declare enum Target {
|
|
2284
2285
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
2285
2286
|
SELF = "SELF",
|
|
2286
2287
|
/** Opens the linked document in a new window or tab */
|
|
@@ -2290,7 +2291,7 @@ declare enum Target {
|
|
|
2290
2291
|
/** Opens the linked document in the full body of the window */
|
|
2291
2292
|
TOP = "TOP"
|
|
2292
2293
|
}
|
|
2293
|
-
interface Rel {
|
|
2294
|
+
export interface Rel {
|
|
2294
2295
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
2295
2296
|
nofollow?: boolean | null;
|
|
2296
2297
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -2300,17 +2301,17 @@ interface Rel {
|
|
|
2300
2301
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
2301
2302
|
noreferrer?: boolean | null;
|
|
2302
2303
|
}
|
|
2303
|
-
interface CodeBlockData {
|
|
2304
|
+
export interface CodeBlockData {
|
|
2304
2305
|
/** Styling for the code block's text. */
|
|
2305
2306
|
textStyle?: TextStyle;
|
|
2306
2307
|
}
|
|
2307
|
-
interface TextStyle {
|
|
2308
|
+
export interface TextStyle {
|
|
2308
2309
|
/** Text alignment. Defaults to `AUTO`. */
|
|
2309
2310
|
textAlignment?: TextAlignment;
|
|
2310
2311
|
/** 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. */
|
|
2311
2312
|
lineHeight?: string | null;
|
|
2312
2313
|
}
|
|
2313
|
-
declare enum TextAlignment {
|
|
2314
|
+
export declare enum TextAlignment {
|
|
2314
2315
|
/** browser default, eqivalent to `initial` */
|
|
2315
2316
|
AUTO = "AUTO",
|
|
2316
2317
|
/** Left align */
|
|
@@ -2322,7 +2323,7 @@ declare enum TextAlignment {
|
|
|
2322
2323
|
/** 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 */
|
|
2323
2324
|
JUSTIFY = "JUSTIFY"
|
|
2324
2325
|
}
|
|
2325
|
-
interface DividerData {
|
|
2326
|
+
export interface DividerData {
|
|
2326
2327
|
/** Styling for the divider's container. */
|
|
2327
2328
|
containerData?: PluginContainerData;
|
|
2328
2329
|
/** Divider line style. */
|
|
@@ -2332,7 +2333,7 @@ interface DividerData {
|
|
|
2332
2333
|
/** Divider alignment. */
|
|
2333
2334
|
alignment?: Alignment;
|
|
2334
2335
|
}
|
|
2335
|
-
declare enum LineStyle {
|
|
2336
|
+
export declare enum LineStyle {
|
|
2336
2337
|
/** Single Line */
|
|
2337
2338
|
SINGLE = "SINGLE",
|
|
2338
2339
|
/** Double Line */
|
|
@@ -2342,7 +2343,7 @@ declare enum LineStyle {
|
|
|
2342
2343
|
/** Dotted Line */
|
|
2343
2344
|
DOTTED = "DOTTED"
|
|
2344
2345
|
}
|
|
2345
|
-
declare enum Width {
|
|
2346
|
+
export declare enum Width {
|
|
2346
2347
|
/** Large line */
|
|
2347
2348
|
LARGE = "LARGE",
|
|
2348
2349
|
/** Medium line */
|
|
@@ -2350,7 +2351,7 @@ declare enum Width {
|
|
|
2350
2351
|
/** Small line */
|
|
2351
2352
|
SMALL = "SMALL"
|
|
2352
2353
|
}
|
|
2353
|
-
declare enum Alignment {
|
|
2354
|
+
export declare enum Alignment {
|
|
2354
2355
|
/** Center alignment */
|
|
2355
2356
|
CENTER = "CENTER",
|
|
2356
2357
|
/** Left alignment */
|
|
@@ -2358,7 +2359,7 @@ declare enum Alignment {
|
|
|
2358
2359
|
/** Right alignment */
|
|
2359
2360
|
RIGHT = "RIGHT"
|
|
2360
2361
|
}
|
|
2361
|
-
interface FileData {
|
|
2362
|
+
export interface FileData {
|
|
2362
2363
|
/** Styling for the file's container. */
|
|
2363
2364
|
containerData?: PluginContainerData;
|
|
2364
2365
|
/** The source for the file's data. */
|
|
@@ -2381,7 +2382,7 @@ interface FileData {
|
|
|
2381
2382
|
/** File size in KB. */
|
|
2382
2383
|
sizeInKb?: string | null;
|
|
2383
2384
|
}
|
|
2384
|
-
declare enum ViewMode {
|
|
2385
|
+
export declare enum ViewMode {
|
|
2385
2386
|
/** No PDF view */
|
|
2386
2387
|
NONE = "NONE",
|
|
2387
2388
|
/** Full PDF view */
|
|
@@ -2389,7 +2390,7 @@ declare enum ViewMode {
|
|
|
2389
2390
|
/** Mini PDF view */
|
|
2390
2391
|
MINI = "MINI"
|
|
2391
2392
|
}
|
|
2392
|
-
interface FileSource extends FileSourceDataOneOf {
|
|
2393
|
+
export interface FileSource extends FileSourceDataOneOf {
|
|
2393
2394
|
/** The absolute URL for the file's source. */
|
|
2394
2395
|
url?: string | null;
|
|
2395
2396
|
/**
|
|
@@ -2403,7 +2404,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
2403
2404
|
private?: boolean | null;
|
|
2404
2405
|
}
|
|
2405
2406
|
/** @oneof */
|
|
2406
|
-
interface FileSourceDataOneOf {
|
|
2407
|
+
export interface FileSourceDataOneOf {
|
|
2407
2408
|
/** The absolute URL for the file's source. */
|
|
2408
2409
|
url?: string | null;
|
|
2409
2410
|
/**
|
|
@@ -2414,7 +2415,7 @@ interface FileSourceDataOneOf {
|
|
|
2414
2415
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
2415
2416
|
_id?: string | null;
|
|
2416
2417
|
}
|
|
2417
|
-
interface PDFSettings {
|
|
2418
|
+
export interface PDFSettings {
|
|
2418
2419
|
/**
|
|
2419
2420
|
* PDF view mode. One of the following:
|
|
2420
2421
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -2427,7 +2428,7 @@ interface PDFSettings {
|
|
|
2427
2428
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
2428
2429
|
disablePrint?: boolean | null;
|
|
2429
2430
|
}
|
|
2430
|
-
interface GalleryData {
|
|
2431
|
+
export interface GalleryData {
|
|
2431
2432
|
/** Styling for the gallery's container. */
|
|
2432
2433
|
containerData?: PluginContainerData;
|
|
2433
2434
|
/** The items in the gallery. */
|
|
@@ -2439,7 +2440,7 @@ interface GalleryData {
|
|
|
2439
2440
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
2440
2441
|
disableDownload?: boolean | null;
|
|
2441
2442
|
}
|
|
2442
|
-
interface Media {
|
|
2443
|
+
export interface Media {
|
|
2443
2444
|
/** The source for the media's data. */
|
|
2444
2445
|
src?: FileSource;
|
|
2445
2446
|
/** Media width in pixels. */
|
|
@@ -2449,19 +2450,19 @@ interface Media {
|
|
|
2449
2450
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
2450
2451
|
duration?: number | null;
|
|
2451
2452
|
}
|
|
2452
|
-
interface Image {
|
|
2453
|
+
export interface Image {
|
|
2453
2454
|
/** Image file details. */
|
|
2454
2455
|
media?: Media;
|
|
2455
2456
|
/** Link details for images that are links. */
|
|
2456
2457
|
link?: Link;
|
|
2457
2458
|
}
|
|
2458
|
-
interface Video {
|
|
2459
|
+
export interface Video {
|
|
2459
2460
|
/** Video file details. */
|
|
2460
2461
|
media?: Media;
|
|
2461
2462
|
/** Video thumbnail file details. */
|
|
2462
2463
|
thumbnail?: Media;
|
|
2463
2464
|
}
|
|
2464
|
-
interface Item extends ItemDataOneOf {
|
|
2465
|
+
export interface Item extends ItemDataOneOf {
|
|
2465
2466
|
/** An image item. */
|
|
2466
2467
|
image?: Image;
|
|
2467
2468
|
/** A video item. */
|
|
@@ -2472,13 +2473,13 @@ interface Item extends ItemDataOneOf {
|
|
|
2472
2473
|
altText?: string | null;
|
|
2473
2474
|
}
|
|
2474
2475
|
/** @oneof */
|
|
2475
|
-
interface ItemDataOneOf {
|
|
2476
|
+
export interface ItemDataOneOf {
|
|
2476
2477
|
/** An image item. */
|
|
2477
2478
|
image?: Image;
|
|
2478
2479
|
/** A video item. */
|
|
2479
2480
|
video?: Video;
|
|
2480
2481
|
}
|
|
2481
|
-
interface GalleryOptions {
|
|
2482
|
+
export interface GalleryOptions {
|
|
2482
2483
|
/** Gallery layout. */
|
|
2483
2484
|
layout?: Layout;
|
|
2484
2485
|
/** Styling for gallery items. */
|
|
@@ -2486,7 +2487,7 @@ interface GalleryOptions {
|
|
|
2486
2487
|
/** Styling for gallery thumbnail images. */
|
|
2487
2488
|
thumbnails?: Thumbnails;
|
|
2488
2489
|
}
|
|
2489
|
-
declare enum LayoutType {
|
|
2490
|
+
export declare enum LayoutType {
|
|
2490
2491
|
/** Collage type */
|
|
2491
2492
|
COLLAGE = "COLLAGE",
|
|
2492
2493
|
/** Masonry type */
|
|
@@ -2508,19 +2509,19 @@ declare enum LayoutType {
|
|
|
2508
2509
|
/** Fullsize images type */
|
|
2509
2510
|
FULLSIZE = "FULLSIZE"
|
|
2510
2511
|
}
|
|
2511
|
-
declare enum Orientation {
|
|
2512
|
+
export declare enum Orientation {
|
|
2512
2513
|
/** Rows Orientation */
|
|
2513
2514
|
ROWS = "ROWS",
|
|
2514
2515
|
/** Columns Orientation */
|
|
2515
2516
|
COLUMNS = "COLUMNS"
|
|
2516
2517
|
}
|
|
2517
|
-
declare enum Crop {
|
|
2518
|
+
export declare enum Crop {
|
|
2518
2519
|
/** Crop to fill */
|
|
2519
2520
|
FILL = "FILL",
|
|
2520
2521
|
/** Crop to fit */
|
|
2521
2522
|
FIT = "FIT"
|
|
2522
2523
|
}
|
|
2523
|
-
declare enum ThumbnailsAlignment {
|
|
2524
|
+
export declare enum ThumbnailsAlignment {
|
|
2524
2525
|
/** Top alignment */
|
|
2525
2526
|
TOP = "TOP",
|
|
2526
2527
|
/** Right alignment */
|
|
@@ -2532,7 +2533,7 @@ declare enum ThumbnailsAlignment {
|
|
|
2532
2533
|
/** No thumbnail */
|
|
2533
2534
|
NONE = "NONE"
|
|
2534
2535
|
}
|
|
2535
|
-
interface Layout {
|
|
2536
|
+
export interface Layout {
|
|
2536
2537
|
/** Gallery layout type. */
|
|
2537
2538
|
type?: LayoutType;
|
|
2538
2539
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -2544,7 +2545,7 @@ interface Layout {
|
|
|
2544
2545
|
/** The number of columns to display on mobile screens. */
|
|
2545
2546
|
mobileNumberOfColumns?: number | null;
|
|
2546
2547
|
}
|
|
2547
|
-
interface ItemStyle {
|
|
2548
|
+
export interface ItemStyle {
|
|
2548
2549
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
2549
2550
|
targetSize?: number | null;
|
|
2550
2551
|
/** Item ratio */
|
|
@@ -2554,13 +2555,13 @@ interface ItemStyle {
|
|
|
2554
2555
|
/** The spacing between items in pixels. */
|
|
2555
2556
|
spacing?: number | null;
|
|
2556
2557
|
}
|
|
2557
|
-
interface Thumbnails {
|
|
2558
|
+
export interface Thumbnails {
|
|
2558
2559
|
/** Thumbnail alignment. */
|
|
2559
2560
|
placement?: ThumbnailsAlignment;
|
|
2560
2561
|
/** Spacing between thumbnails in pixels. */
|
|
2561
2562
|
spacing?: number | null;
|
|
2562
2563
|
}
|
|
2563
|
-
interface GIFData {
|
|
2564
|
+
export interface GIFData {
|
|
2564
2565
|
/** Styling for the GIF's container. */
|
|
2565
2566
|
containerData?: PluginContainerData;
|
|
2566
2567
|
/** The source of the full size GIF. */
|
|
@@ -2574,7 +2575,7 @@ interface GIFData {
|
|
|
2574
2575
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2575
2576
|
gifType?: GIFType;
|
|
2576
2577
|
}
|
|
2577
|
-
interface GIF {
|
|
2578
|
+
export interface GIF {
|
|
2578
2579
|
/**
|
|
2579
2580
|
* GIF format URL.
|
|
2580
2581
|
* @format WEB_URL
|
|
@@ -2591,11 +2592,11 @@ interface GIF {
|
|
|
2591
2592
|
*/
|
|
2592
2593
|
still?: string | null;
|
|
2593
2594
|
}
|
|
2594
|
-
declare enum GIFType {
|
|
2595
|
+
export declare enum GIFType {
|
|
2595
2596
|
NORMAL = "NORMAL",
|
|
2596
2597
|
STICKER = "STICKER"
|
|
2597
2598
|
}
|
|
2598
|
-
interface HeadingData {
|
|
2599
|
+
export interface HeadingData {
|
|
2599
2600
|
/** Heading level from 1-6. */
|
|
2600
2601
|
level?: number;
|
|
2601
2602
|
/** Styling for the heading text. */
|
|
@@ -2603,7 +2604,7 @@ interface HeadingData {
|
|
|
2603
2604
|
/** Indentation level from 1-4. */
|
|
2604
2605
|
indentation?: number | null;
|
|
2605
2606
|
}
|
|
2606
|
-
interface HTMLData extends HTMLDataDataOneOf {
|
|
2607
|
+
export interface HTMLData extends HTMLDataDataOneOf {
|
|
2607
2608
|
/** The URL for the HTML code for the node. */
|
|
2608
2609
|
url?: string;
|
|
2609
2610
|
/** The HTML code for the node. */
|
|
@@ -2621,7 +2622,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2621
2622
|
autoHeight?: boolean | null;
|
|
2622
2623
|
}
|
|
2623
2624
|
/** @oneof */
|
|
2624
|
-
interface HTMLDataDataOneOf {
|
|
2625
|
+
export interface HTMLDataDataOneOf {
|
|
2625
2626
|
/** The URL for the HTML code for the node. */
|
|
2626
2627
|
url?: string;
|
|
2627
2628
|
/** The HTML code for the node. */
|
|
@@ -2632,11 +2633,11 @@ interface HTMLDataDataOneOf {
|
|
|
2632
2633
|
*/
|
|
2633
2634
|
isAdsense?: boolean | null;
|
|
2634
2635
|
}
|
|
2635
|
-
declare enum Source {
|
|
2636
|
+
export declare enum Source {
|
|
2636
2637
|
HTML = "HTML",
|
|
2637
2638
|
ADSENSE = "ADSENSE"
|
|
2638
2639
|
}
|
|
2639
|
-
interface ImageData {
|
|
2640
|
+
export interface ImageData {
|
|
2640
2641
|
/** Styling for the image's container. */
|
|
2641
2642
|
containerData?: PluginContainerData;
|
|
2642
2643
|
/** Image file details. */
|
|
@@ -2659,7 +2660,7 @@ interface ImageData {
|
|
|
2659
2660
|
/** Styling for the image. */
|
|
2660
2661
|
styles?: ImageDataStyles;
|
|
2661
2662
|
}
|
|
2662
|
-
interface StylesBorder {
|
|
2663
|
+
export interface StylesBorder {
|
|
2663
2664
|
/** Border width in pixels. */
|
|
2664
2665
|
width?: number | null;
|
|
2665
2666
|
/**
|
|
@@ -2670,11 +2671,11 @@ interface StylesBorder {
|
|
|
2670
2671
|
/** Border radius in pixels. */
|
|
2671
2672
|
radius?: number | null;
|
|
2672
2673
|
}
|
|
2673
|
-
interface ImageDataStyles {
|
|
2674
|
+
export interface ImageDataStyles {
|
|
2674
2675
|
/** Border attributes. */
|
|
2675
2676
|
border?: StylesBorder;
|
|
2676
2677
|
}
|
|
2677
|
-
interface LinkPreviewData {
|
|
2678
|
+
export interface LinkPreviewData {
|
|
2678
2679
|
/** Styling for the link preview's container. */
|
|
2679
2680
|
containerData?: PluginContainerData;
|
|
2680
2681
|
/** Link details. */
|
|
@@ -2690,7 +2691,7 @@ interface LinkPreviewData {
|
|
|
2690
2691
|
/** Styling for the link preview. */
|
|
2691
2692
|
styles?: LinkPreviewDataStyles;
|
|
2692
2693
|
}
|
|
2693
|
-
declare enum Position {
|
|
2694
|
+
export declare enum Position {
|
|
2694
2695
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2695
2696
|
START = "START",
|
|
2696
2697
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2700,7 +2701,7 @@ declare enum Position {
|
|
|
2700
2701
|
/** Thumbnail hidden and not displayed */
|
|
2701
2702
|
HIDDEN = "HIDDEN"
|
|
2702
2703
|
}
|
|
2703
|
-
interface LinkPreviewDataStyles {
|
|
2704
|
+
export interface LinkPreviewDataStyles {
|
|
2704
2705
|
/**
|
|
2705
2706
|
* Background color as a hexadecimal value.
|
|
2706
2707
|
* @format COLOR_HEX
|
|
@@ -2733,13 +2734,13 @@ interface LinkPreviewDataStyles {
|
|
|
2733
2734
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2734
2735
|
thumbnailPosition?: Position;
|
|
2735
2736
|
}
|
|
2736
|
-
interface MapData {
|
|
2737
|
+
export interface MapData {
|
|
2737
2738
|
/** Styling for the map's container. */
|
|
2738
2739
|
containerData?: PluginContainerData;
|
|
2739
2740
|
/** Map settings. */
|
|
2740
2741
|
mapSettings?: MapSettings;
|
|
2741
2742
|
}
|
|
2742
|
-
interface MapSettings {
|
|
2743
|
+
export interface MapSettings {
|
|
2743
2744
|
/** The address to display on the map. */
|
|
2744
2745
|
address?: string | null;
|
|
2745
2746
|
/** Sets whether the map is draggable. */
|
|
@@ -2763,7 +2764,7 @@ interface MapSettings {
|
|
|
2763
2764
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2764
2765
|
mapType?: MapType;
|
|
2765
2766
|
}
|
|
2766
|
-
declare enum MapType {
|
|
2767
|
+
export declare enum MapType {
|
|
2767
2768
|
/** Roadmap map type */
|
|
2768
2769
|
ROADMAP = "ROADMAP",
|
|
2769
2770
|
/** Satellite map type */
|
|
@@ -2773,7 +2774,7 @@ declare enum MapType {
|
|
|
2773
2774
|
/** Terrain map type */
|
|
2774
2775
|
TERRAIN = "TERRAIN"
|
|
2775
2776
|
}
|
|
2776
|
-
interface ParagraphData {
|
|
2777
|
+
export interface ParagraphData {
|
|
2777
2778
|
/** Styling for the paragraph text. */
|
|
2778
2779
|
textStyle?: TextStyle;
|
|
2779
2780
|
/** Indentation level from 1-4. */
|
|
@@ -2781,7 +2782,7 @@ interface ParagraphData {
|
|
|
2781
2782
|
/** Paragraph level */
|
|
2782
2783
|
level?: number | null;
|
|
2783
2784
|
}
|
|
2784
|
-
interface PollData {
|
|
2785
|
+
export interface PollData {
|
|
2785
2786
|
/** Styling for the poll's container. */
|
|
2786
2787
|
containerData?: PluginContainerData;
|
|
2787
2788
|
/** Poll data. */
|
|
@@ -2791,7 +2792,7 @@ interface PollData {
|
|
|
2791
2792
|
/** Styling for the poll and voting options. */
|
|
2792
2793
|
design?: Design;
|
|
2793
2794
|
}
|
|
2794
|
-
declare enum ViewRole {
|
|
2795
|
+
export declare enum ViewRole {
|
|
2795
2796
|
/** Only Poll creator can view the results */
|
|
2796
2797
|
CREATOR = "CREATOR",
|
|
2797
2798
|
/** Anyone who voted can see the results */
|
|
@@ -2799,13 +2800,13 @@ declare enum ViewRole {
|
|
|
2799
2800
|
/** Anyone can see the results, even if one didn't vote */
|
|
2800
2801
|
EVERYONE = "EVERYONE"
|
|
2801
2802
|
}
|
|
2802
|
-
declare enum VoteRole {
|
|
2803
|
+
export declare enum VoteRole {
|
|
2803
2804
|
/** Logged in member */
|
|
2804
2805
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2805
2806
|
/** Anyone */
|
|
2806
2807
|
ALL = "ALL"
|
|
2807
2808
|
}
|
|
2808
|
-
interface Permissions {
|
|
2809
|
+
export interface Permissions {
|
|
2809
2810
|
/** Sets who can view the poll results. */
|
|
2810
2811
|
view?: ViewRole;
|
|
2811
2812
|
/** Sets who can vote. */
|
|
@@ -2813,7 +2814,7 @@ interface Permissions {
|
|
|
2813
2814
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2814
2815
|
allowMultipleVotes?: boolean | null;
|
|
2815
2816
|
}
|
|
2816
|
-
interface Option {
|
|
2817
|
+
export interface Option {
|
|
2817
2818
|
/** Option ID. */
|
|
2818
2819
|
_id?: string | null;
|
|
2819
2820
|
/** Option title. */
|
|
@@ -2821,7 +2822,7 @@ interface Option {
|
|
|
2821
2822
|
/** The image displayed with the option. */
|
|
2822
2823
|
image?: Media;
|
|
2823
2824
|
}
|
|
2824
|
-
interface PollSettings {
|
|
2825
|
+
export interface PollSettings {
|
|
2825
2826
|
/** Permissions settings for voting. */
|
|
2826
2827
|
permissions?: Permissions;
|
|
2827
2828
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2829,19 +2830,19 @@ interface PollSettings {
|
|
|
2829
2830
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2830
2831
|
showVotesCount?: boolean | null;
|
|
2831
2832
|
}
|
|
2832
|
-
declare enum PollLayoutType {
|
|
2833
|
+
export declare enum PollLayoutType {
|
|
2833
2834
|
/** List */
|
|
2834
2835
|
LIST = "LIST",
|
|
2835
2836
|
/** Grid */
|
|
2836
2837
|
GRID = "GRID"
|
|
2837
2838
|
}
|
|
2838
|
-
declare enum PollLayoutDirection {
|
|
2839
|
+
export declare enum PollLayoutDirection {
|
|
2839
2840
|
/** Left-to-right */
|
|
2840
2841
|
LTR = "LTR",
|
|
2841
2842
|
/** Right-to-left */
|
|
2842
2843
|
RTL = "RTL"
|
|
2843
2844
|
}
|
|
2844
|
-
interface PollLayout {
|
|
2845
|
+
export interface PollLayout {
|
|
2845
2846
|
/** The layout for displaying the voting options. */
|
|
2846
2847
|
type?: PollLayoutType;
|
|
2847
2848
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2849,11 +2850,11 @@ interface PollLayout {
|
|
|
2849
2850
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2850
2851
|
enableImage?: boolean | null;
|
|
2851
2852
|
}
|
|
2852
|
-
interface OptionLayout {
|
|
2853
|
+
export interface OptionLayout {
|
|
2853
2854
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2854
2855
|
enableImage?: boolean | null;
|
|
2855
2856
|
}
|
|
2856
|
-
declare enum BackgroundType {
|
|
2857
|
+
export declare enum BackgroundType {
|
|
2857
2858
|
/** Color background type */
|
|
2858
2859
|
COLOR = "COLOR",
|
|
2859
2860
|
/** Image background type */
|
|
@@ -2861,7 +2862,7 @@ declare enum BackgroundType {
|
|
|
2861
2862
|
/** Gradiant background type */
|
|
2862
2863
|
GRADIENT = "GRADIENT"
|
|
2863
2864
|
}
|
|
2864
|
-
interface Gradient {
|
|
2865
|
+
export interface Gradient {
|
|
2865
2866
|
/** The gradient angle in degrees. */
|
|
2866
2867
|
angle?: number | null;
|
|
2867
2868
|
/**
|
|
@@ -2875,7 +2876,7 @@ interface Gradient {
|
|
|
2875
2876
|
*/
|
|
2876
2877
|
lastColor?: string | null;
|
|
2877
2878
|
}
|
|
2878
|
-
interface Background extends BackgroundBackgroundOneOf {
|
|
2879
|
+
export interface Background extends BackgroundBackgroundOneOf {
|
|
2879
2880
|
/**
|
|
2880
2881
|
* The background color as a hexademical value.
|
|
2881
2882
|
* @format COLOR_HEX
|
|
@@ -2889,7 +2890,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
2889
2890
|
type?: BackgroundType;
|
|
2890
2891
|
}
|
|
2891
2892
|
/** @oneof */
|
|
2892
|
-
interface BackgroundBackgroundOneOf {
|
|
2893
|
+
export interface BackgroundBackgroundOneOf {
|
|
2893
2894
|
/**
|
|
2894
2895
|
* The background color as a hexademical value.
|
|
2895
2896
|
* @format COLOR_HEX
|
|
@@ -2900,17 +2901,17 @@ interface BackgroundBackgroundOneOf {
|
|
|
2900
2901
|
/** Details for a gradient background. */
|
|
2901
2902
|
gradient?: Gradient;
|
|
2902
2903
|
}
|
|
2903
|
-
interface PollDesign {
|
|
2904
|
+
export interface PollDesign {
|
|
2904
2905
|
/** Background styling. */
|
|
2905
2906
|
background?: Background;
|
|
2906
2907
|
/** Border radius in pixels. */
|
|
2907
2908
|
borderRadius?: number | null;
|
|
2908
2909
|
}
|
|
2909
|
-
interface OptionDesign {
|
|
2910
|
+
export interface OptionDesign {
|
|
2910
2911
|
/** Border radius in pixels. */
|
|
2911
2912
|
borderRadius?: number | null;
|
|
2912
2913
|
}
|
|
2913
|
-
interface Poll {
|
|
2914
|
+
export interface Poll {
|
|
2914
2915
|
/** Poll ID. */
|
|
2915
2916
|
_id?: string | null;
|
|
2916
2917
|
/** Poll title. */
|
|
@@ -2924,26 +2925,26 @@ interface Poll {
|
|
|
2924
2925
|
/** The poll's permissions and display settings. */
|
|
2925
2926
|
settings?: PollSettings;
|
|
2926
2927
|
}
|
|
2927
|
-
interface PollDataLayout {
|
|
2928
|
+
export interface PollDataLayout {
|
|
2928
2929
|
/** Poll layout settings. */
|
|
2929
2930
|
poll?: PollLayout;
|
|
2930
2931
|
/** Voting otpions layout settings. */
|
|
2931
2932
|
options?: OptionLayout;
|
|
2932
2933
|
}
|
|
2933
|
-
interface Design {
|
|
2934
|
+
export interface Design {
|
|
2934
2935
|
/** Styling for the poll. */
|
|
2935
2936
|
poll?: PollDesign;
|
|
2936
2937
|
/** Styling for voting options. */
|
|
2937
2938
|
options?: OptionDesign;
|
|
2938
2939
|
}
|
|
2939
|
-
interface TextData {
|
|
2940
|
+
export interface TextData {
|
|
2940
2941
|
/** The text to apply decorations to. */
|
|
2941
2942
|
text?: string;
|
|
2942
2943
|
/** The decorations to apply. */
|
|
2943
2944
|
decorations?: Decoration[];
|
|
2944
2945
|
}
|
|
2945
2946
|
/** Adds appearence changes to text */
|
|
2946
|
-
interface Decoration extends DecorationDataOneOf {
|
|
2947
|
+
export interface Decoration extends DecorationDataOneOf {
|
|
2947
2948
|
/** Data for an anchor link decoration. */
|
|
2948
2949
|
anchorData?: AnchorData;
|
|
2949
2950
|
/** Data for a color decoration. */
|
|
@@ -2966,7 +2967,7 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
2966
2967
|
type?: DecorationType;
|
|
2967
2968
|
}
|
|
2968
2969
|
/** @oneof */
|
|
2969
|
-
interface DecorationDataOneOf {
|
|
2970
|
+
export interface DecorationDataOneOf {
|
|
2970
2971
|
/** Data for an anchor link decoration. */
|
|
2971
2972
|
anchorData?: AnchorData;
|
|
2972
2973
|
/** Data for a color decoration. */
|
|
@@ -2986,7 +2987,7 @@ interface DecorationDataOneOf {
|
|
|
2986
2987
|
/** Data for a spoiler decoration. */
|
|
2987
2988
|
spoilerData?: SpoilerData;
|
|
2988
2989
|
}
|
|
2989
|
-
declare enum DecorationType {
|
|
2990
|
+
export declare enum DecorationType {
|
|
2990
2991
|
BOLD = "BOLD",
|
|
2991
2992
|
ITALIC = "ITALIC",
|
|
2992
2993
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2998,21 +2999,21 @@ declare enum DecorationType {
|
|
|
2998
2999
|
FONT_SIZE = "FONT_SIZE",
|
|
2999
3000
|
EXTERNAL = "EXTERNAL"
|
|
3000
3001
|
}
|
|
3001
|
-
interface AnchorData {
|
|
3002
|
+
export interface AnchorData {
|
|
3002
3003
|
/** The target node's ID. */
|
|
3003
3004
|
anchor?: string;
|
|
3004
3005
|
}
|
|
3005
|
-
interface ColorData {
|
|
3006
|
+
export interface ColorData {
|
|
3006
3007
|
/** The text's background color as a hexadecimal value. */
|
|
3007
3008
|
background?: string | null;
|
|
3008
3009
|
/** The text's foreground color as a hexadecimal value. */
|
|
3009
3010
|
foreground?: string | null;
|
|
3010
3011
|
}
|
|
3011
|
-
interface LinkData {
|
|
3012
|
+
export interface LinkData {
|
|
3012
3013
|
/** Link details. */
|
|
3013
3014
|
link?: Link;
|
|
3014
3015
|
}
|
|
3015
|
-
interface MentionData {
|
|
3016
|
+
export interface MentionData {
|
|
3016
3017
|
/** The mentioned user's name. */
|
|
3017
3018
|
name?: string;
|
|
3018
3019
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -3020,21 +3021,21 @@ interface MentionData {
|
|
|
3020
3021
|
/** Mentioned user's ID. */
|
|
3021
3022
|
_id?: string | null;
|
|
3022
3023
|
}
|
|
3023
|
-
interface FontSizeData {
|
|
3024
|
+
export interface FontSizeData {
|
|
3024
3025
|
/** The units used for the font size. */
|
|
3025
3026
|
unit?: FontType;
|
|
3026
3027
|
/** Font size value. */
|
|
3027
3028
|
value?: number | null;
|
|
3028
3029
|
}
|
|
3029
|
-
declare enum FontType {
|
|
3030
|
+
export declare enum FontType {
|
|
3030
3031
|
PX = "PX",
|
|
3031
3032
|
EM = "EM"
|
|
3032
3033
|
}
|
|
3033
|
-
interface SpoilerData {
|
|
3034
|
+
export interface SpoilerData {
|
|
3034
3035
|
/** Spoiler ID. */
|
|
3035
3036
|
_id?: string | null;
|
|
3036
3037
|
}
|
|
3037
|
-
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
3038
|
+
export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
3038
3039
|
/** Data for embedded Wix Bookings content. */
|
|
3039
3040
|
bookingData?: BookingData;
|
|
3040
3041
|
/** Data for embedded Wix Events content. */
|
|
@@ -3056,28 +3057,28 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
3056
3057
|
image?: Media;
|
|
3057
3058
|
}
|
|
3058
3059
|
/** @oneof */
|
|
3059
|
-
interface AppEmbedDataAppDataOneOf {
|
|
3060
|
+
export interface AppEmbedDataAppDataOneOf {
|
|
3060
3061
|
/** Data for embedded Wix Bookings content. */
|
|
3061
3062
|
bookingData?: BookingData;
|
|
3062
3063
|
/** Data for embedded Wix Events content. */
|
|
3063
3064
|
eventData?: EventData;
|
|
3064
3065
|
}
|
|
3065
|
-
declare enum AppType {
|
|
3066
|
+
export declare enum AppType {
|
|
3066
3067
|
PRODUCT = "PRODUCT",
|
|
3067
3068
|
EVENT = "EVENT",
|
|
3068
3069
|
BOOKING = "BOOKING"
|
|
3069
3070
|
}
|
|
3070
|
-
interface BookingData {
|
|
3071
|
+
export interface BookingData {
|
|
3071
3072
|
/** Booking duration in minutes. */
|
|
3072
3073
|
durations?: string | null;
|
|
3073
3074
|
}
|
|
3074
|
-
interface EventData {
|
|
3075
|
+
export interface EventData {
|
|
3075
3076
|
/** Event schedule. */
|
|
3076
3077
|
scheduling?: string | null;
|
|
3077
3078
|
/** Event location. */
|
|
3078
3079
|
location?: string | null;
|
|
3079
3080
|
}
|
|
3080
|
-
interface VideoData {
|
|
3081
|
+
export interface VideoData {
|
|
3081
3082
|
/** Styling for the video's container. */
|
|
3082
3083
|
containerData?: PluginContainerData;
|
|
3083
3084
|
/** Video details. */
|
|
@@ -3091,7 +3092,7 @@ interface VideoData {
|
|
|
3091
3092
|
/** Video options. */
|
|
3092
3093
|
options?: PlaybackOptions;
|
|
3093
3094
|
}
|
|
3094
|
-
interface PlaybackOptions {
|
|
3095
|
+
export interface PlaybackOptions {
|
|
3095
3096
|
/** Sets whether the media will automatically start playing. */
|
|
3096
3097
|
autoPlay?: boolean | null;
|
|
3097
3098
|
/** Sets whether media's will be looped. */
|
|
@@ -3099,7 +3100,7 @@ interface PlaybackOptions {
|
|
|
3099
3100
|
/** Sets whether media's controls will be shown. */
|
|
3100
3101
|
showControls?: boolean | null;
|
|
3101
3102
|
}
|
|
3102
|
-
interface EmbedData {
|
|
3103
|
+
export interface EmbedData {
|
|
3103
3104
|
/** Styling for the oEmbed node's container. */
|
|
3104
3105
|
containerData?: PluginContainerData;
|
|
3105
3106
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -3107,7 +3108,7 @@ interface EmbedData {
|
|
|
3107
3108
|
/** Origin asset source. */
|
|
3108
3109
|
src?: string | null;
|
|
3109
3110
|
}
|
|
3110
|
-
interface Oembed {
|
|
3111
|
+
export interface Oembed {
|
|
3111
3112
|
/** The resource type. */
|
|
3112
3113
|
type?: string | null;
|
|
3113
3114
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -3139,7 +3140,7 @@ interface Oembed {
|
|
|
3139
3140
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
3140
3141
|
version?: string | null;
|
|
3141
3142
|
}
|
|
3142
|
-
interface CollapsibleListData {
|
|
3143
|
+
export interface CollapsibleListData {
|
|
3143
3144
|
/** Styling for the collapsible list's container. */
|
|
3144
3145
|
containerData?: PluginContainerData;
|
|
3145
3146
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -3151,7 +3152,7 @@ interface CollapsibleListData {
|
|
|
3151
3152
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
3152
3153
|
isQapageData?: boolean | null;
|
|
3153
3154
|
}
|
|
3154
|
-
declare enum InitialExpandedItems {
|
|
3155
|
+
export declare enum InitialExpandedItems {
|
|
3155
3156
|
/** First item will be expended initally */
|
|
3156
3157
|
FIRST = "FIRST",
|
|
3157
3158
|
/** All items will expended initally */
|
|
@@ -3159,13 +3160,13 @@ declare enum InitialExpandedItems {
|
|
|
3159
3160
|
/** All items collapsed initally */
|
|
3160
3161
|
NONE = "NONE"
|
|
3161
3162
|
}
|
|
3162
|
-
declare enum Direction {
|
|
3163
|
+
export declare enum Direction {
|
|
3163
3164
|
/** Left-to-right */
|
|
3164
3165
|
LTR = "LTR",
|
|
3165
3166
|
/** Right-to-left */
|
|
3166
3167
|
RTL = "RTL"
|
|
3167
3168
|
}
|
|
3168
|
-
interface TableData {
|
|
3169
|
+
export interface TableData {
|
|
3169
3170
|
/** Styling for the table's container. */
|
|
3170
3171
|
containerData?: PluginContainerData;
|
|
3171
3172
|
/** The table's dimensions. */
|
|
@@ -3180,7 +3181,7 @@ interface TableData {
|
|
|
3180
3181
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
3181
3182
|
columnHeader?: boolean | null;
|
|
3182
3183
|
}
|
|
3183
|
-
interface Dimensions {
|
|
3184
|
+
export interface Dimensions {
|
|
3184
3185
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
3185
3186
|
colsWidthRatio?: number[];
|
|
3186
3187
|
/** An array representing the height of each row in pixels. */
|
|
@@ -3188,13 +3189,13 @@ interface Dimensions {
|
|
|
3188
3189
|
/** An array representing the minimum width of each column in pixels. */
|
|
3189
3190
|
colsMinWidth?: number[];
|
|
3190
3191
|
}
|
|
3191
|
-
interface TableCellData {
|
|
3192
|
+
export interface TableCellData {
|
|
3192
3193
|
/** Styling for the cell's background color and text alignment. */
|
|
3193
3194
|
cellStyle?: CellStyle;
|
|
3194
3195
|
/** The cell's border colors. */
|
|
3195
3196
|
borderColors?: BorderColors;
|
|
3196
3197
|
}
|
|
3197
|
-
declare enum VerticalAlignment {
|
|
3198
|
+
export declare enum VerticalAlignment {
|
|
3198
3199
|
/** Top alignment */
|
|
3199
3200
|
TOP = "TOP",
|
|
3200
3201
|
/** Middle alignment */
|
|
@@ -3202,7 +3203,7 @@ declare enum VerticalAlignment {
|
|
|
3202
3203
|
/** Bottom alignment */
|
|
3203
3204
|
BOTTOM = "BOTTOM"
|
|
3204
3205
|
}
|
|
3205
|
-
interface CellStyle {
|
|
3206
|
+
export interface CellStyle {
|
|
3206
3207
|
/** Vertical alignment for the cell's text. */
|
|
3207
3208
|
verticalAlignment?: VerticalAlignment;
|
|
3208
3209
|
/**
|
|
@@ -3211,7 +3212,7 @@ interface CellStyle {
|
|
|
3211
3212
|
*/
|
|
3212
3213
|
backgroundColor?: string | null;
|
|
3213
3214
|
}
|
|
3214
|
-
interface BorderColors {
|
|
3215
|
+
export interface BorderColors {
|
|
3215
3216
|
/**
|
|
3216
3217
|
* Left border color as a hexadecimal value.
|
|
3217
3218
|
* @format COLOR_HEX
|
|
@@ -3239,7 +3240,7 @@ interface BorderColors {
|
|
|
3239
3240
|
*
|
|
3240
3241
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
3241
3242
|
*/
|
|
3242
|
-
declare enum NullValue {
|
|
3243
|
+
export declare enum NullValue {
|
|
3243
3244
|
/** Null value. */
|
|
3244
3245
|
NULL_VALUE = "NULL_VALUE"
|
|
3245
3246
|
}
|
|
@@ -3248,11 +3249,11 @@ declare enum NullValue {
|
|
|
3248
3249
|
*
|
|
3249
3250
|
* The JSON representation for `ListValue` is JSON array.
|
|
3250
3251
|
*/
|
|
3251
|
-
interface ListValue {
|
|
3252
|
+
export interface ListValue {
|
|
3252
3253
|
/** Repeated field of dynamically typed values. */
|
|
3253
3254
|
values?: any[];
|
|
3254
3255
|
}
|
|
3255
|
-
interface AudioData {
|
|
3256
|
+
export interface AudioData {
|
|
3256
3257
|
/** Styling for the audio node's container. */
|
|
3257
3258
|
containerData?: PluginContainerData;
|
|
3258
3259
|
/** Audio file details. */
|
|
@@ -3268,7 +3269,7 @@ interface AudioData {
|
|
|
3268
3269
|
/** An HTML version of the audio node. */
|
|
3269
3270
|
html?: string | null;
|
|
3270
3271
|
}
|
|
3271
|
-
interface OrderedListData {
|
|
3272
|
+
export interface OrderedListData {
|
|
3272
3273
|
/** Indentation level from 0-4. */
|
|
3273
3274
|
indentation?: number;
|
|
3274
3275
|
/** Offset level from 0-4. */
|
|
@@ -3276,24 +3277,24 @@ interface OrderedListData {
|
|
|
3276
3277
|
/** List start number. */
|
|
3277
3278
|
start?: number | null;
|
|
3278
3279
|
}
|
|
3279
|
-
interface BulletedListData {
|
|
3280
|
+
export interface BulletedListData {
|
|
3280
3281
|
/** Indentation level from 0-4. */
|
|
3281
3282
|
indentation?: number;
|
|
3282
3283
|
/** Offset level from 0-4. */
|
|
3283
3284
|
offset?: number | null;
|
|
3284
3285
|
}
|
|
3285
|
-
interface BlockquoteData {
|
|
3286
|
+
export interface BlockquoteData {
|
|
3286
3287
|
/** Indentation level from 1-4. */
|
|
3287
3288
|
indentation?: number;
|
|
3288
3289
|
}
|
|
3289
|
-
interface CaptionData {
|
|
3290
|
+
export interface CaptionData {
|
|
3290
3291
|
textStyle?: TextStyle;
|
|
3291
3292
|
}
|
|
3292
|
-
interface LayoutCellData {
|
|
3293
|
+
export interface LayoutCellData {
|
|
3293
3294
|
/** Size of the cell in 12 columns grid. */
|
|
3294
3295
|
colSpan?: number | null;
|
|
3295
3296
|
}
|
|
3296
|
-
interface Metadata {
|
|
3297
|
+
export interface Metadata {
|
|
3297
3298
|
/** Schema version. */
|
|
3298
3299
|
version?: number;
|
|
3299
3300
|
/**
|
|
@@ -3310,7 +3311,7 @@ interface Metadata {
|
|
|
3310
3311
|
/** Object ID. */
|
|
3311
3312
|
_id?: string | null;
|
|
3312
3313
|
}
|
|
3313
|
-
interface DocumentStyle {
|
|
3314
|
+
export interface DocumentStyle {
|
|
3314
3315
|
/** Styling for H1 nodes. */
|
|
3315
3316
|
headerOne?: TextNodeStyle;
|
|
3316
3317
|
/** Styling for H2 nodes. */
|
|
@@ -3330,7 +3331,7 @@ interface DocumentStyle {
|
|
|
3330
3331
|
/** Styling for code block nodes. */
|
|
3331
3332
|
codeBlock?: TextNodeStyle;
|
|
3332
3333
|
}
|
|
3333
|
-
interface TextNodeStyle {
|
|
3334
|
+
export interface TextNodeStyle {
|
|
3334
3335
|
/** The decorations to apply to the node. */
|
|
3335
3336
|
decorations?: Decoration[];
|
|
3336
3337
|
/** Padding and background color for the node. */
|
|
@@ -3338,7 +3339,7 @@ interface TextNodeStyle {
|
|
|
3338
3339
|
/** Line height for text in the node. */
|
|
3339
3340
|
lineHeight?: string | null;
|
|
3340
3341
|
}
|
|
3341
|
-
interface Badge {
|
|
3342
|
+
export interface Badge {
|
|
3342
3343
|
/** Badge type. */
|
|
3343
3344
|
type?: Type;
|
|
3344
3345
|
/**
|
|
@@ -3347,7 +3348,7 @@ interface Badge {
|
|
|
3347
3348
|
*/
|
|
3348
3349
|
text?: string | null;
|
|
3349
3350
|
}
|
|
3350
|
-
declare enum Type {
|
|
3351
|
+
export declare enum Type {
|
|
3351
3352
|
/** Unknown badge type. */
|
|
3352
3353
|
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
3353
3354
|
/** Urgent badge type. */
|
|
@@ -3357,7 +3358,7 @@ declare enum Type {
|
|
|
3357
3358
|
/** General badge type. */
|
|
3358
3359
|
GENERAL = "GENERAL"
|
|
3359
3360
|
}
|
|
3360
|
-
interface EventUpdated {
|
|
3361
|
+
export interface EventUpdated {
|
|
3361
3362
|
/** Event update timestamp in ISO UTC format. */
|
|
3362
3363
|
timestamp?: Date | null;
|
|
3363
3364
|
/**
|
|
@@ -3379,7 +3380,7 @@ interface EventUpdated {
|
|
|
3379
3380
|
/** Updated event */
|
|
3380
3381
|
event?: Event;
|
|
3381
3382
|
}
|
|
3382
|
-
interface SeatingPlanCategoriesSummaryUpdated {
|
|
3383
|
+
export interface SeatingPlanCategoriesSummaryUpdated {
|
|
3383
3384
|
/**
|
|
3384
3385
|
* Seating plan id
|
|
3385
3386
|
* @format GUID
|
|
@@ -3398,7 +3399,7 @@ interface SeatingPlanCategoriesSummaryUpdated {
|
|
|
3398
3399
|
*/
|
|
3399
3400
|
revision?: string | null;
|
|
3400
3401
|
}
|
|
3401
|
-
interface CategoryDetails {
|
|
3402
|
+
export interface CategoryDetails {
|
|
3402
3403
|
/**
|
|
3403
3404
|
* Seating plan id
|
|
3404
3405
|
* @format GUID
|
|
@@ -3430,7 +3431,7 @@ interface CategoryDetails {
|
|
|
3430
3431
|
*/
|
|
3431
3432
|
reserved?: number | null;
|
|
3432
3433
|
}
|
|
3433
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3434
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
3434
3435
|
createdEvent?: EntityCreatedEvent;
|
|
3435
3436
|
updatedEvent?: EntityUpdatedEvent;
|
|
3436
3437
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -3473,19 +3474,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3473
3474
|
entityEventSequence?: string | null;
|
|
3474
3475
|
}
|
|
3475
3476
|
/** @oneof */
|
|
3476
|
-
interface DomainEventBodyOneOf {
|
|
3477
|
+
export interface DomainEventBodyOneOf {
|
|
3477
3478
|
createdEvent?: EntityCreatedEvent;
|
|
3478
3479
|
updatedEvent?: EntityUpdatedEvent;
|
|
3479
3480
|
deletedEvent?: EntityDeletedEvent;
|
|
3480
3481
|
actionEvent?: ActionEvent;
|
|
3481
3482
|
}
|
|
3482
|
-
interface EntityCreatedEvent {
|
|
3483
|
+
export interface EntityCreatedEvent {
|
|
3483
3484
|
entity?: string;
|
|
3484
3485
|
}
|
|
3485
|
-
interface RestoreInfo {
|
|
3486
|
+
export interface RestoreInfo {
|
|
3486
3487
|
deletedDate?: Date | null;
|
|
3487
3488
|
}
|
|
3488
|
-
interface EntityUpdatedEvent {
|
|
3489
|
+
export interface EntityUpdatedEvent {
|
|
3489
3490
|
/**
|
|
3490
3491
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3491
3492
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -3493,14 +3494,14 @@ interface EntityUpdatedEvent {
|
|
|
3493
3494
|
*/
|
|
3494
3495
|
currentEntity?: string;
|
|
3495
3496
|
}
|
|
3496
|
-
interface EntityDeletedEvent {
|
|
3497
|
+
export interface EntityDeletedEvent {
|
|
3497
3498
|
/** Entity that was deleted */
|
|
3498
3499
|
deletedEntity?: string | null;
|
|
3499
3500
|
}
|
|
3500
|
-
interface ActionEvent {
|
|
3501
|
+
export interface ActionEvent {
|
|
3501
3502
|
body?: string;
|
|
3502
3503
|
}
|
|
3503
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
3504
|
+
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
3504
3505
|
/** Emitted on a meta site creation. */
|
|
3505
3506
|
siteCreated?: SiteCreated;
|
|
3506
3507
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -3548,7 +3549,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
3548
3549
|
assets?: Asset[];
|
|
3549
3550
|
}
|
|
3550
3551
|
/** @oneof */
|
|
3551
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
3552
|
+
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
3552
3553
|
/** Emitted on a meta site creation. */
|
|
3553
3554
|
siteCreated?: SiteCreated;
|
|
3554
3555
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -3580,7 +3581,7 @@ interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
3580
3581
|
/** Emitted when Studio is detached. */
|
|
3581
3582
|
studioUnassigned?: StudioUnassigned;
|
|
3582
3583
|
}
|
|
3583
|
-
interface Asset {
|
|
3584
|
+
export interface Asset {
|
|
3584
3585
|
/**
|
|
3585
3586
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
3586
3587
|
* @maxLength 36
|
|
@@ -3594,14 +3595,14 @@ interface Asset {
|
|
|
3594
3595
|
/** An application state. */
|
|
3595
3596
|
state?: State;
|
|
3596
3597
|
}
|
|
3597
|
-
declare enum State {
|
|
3598
|
+
export declare enum State {
|
|
3598
3599
|
UNKNOWN = "UNKNOWN",
|
|
3599
3600
|
ENABLED = "ENABLED",
|
|
3600
3601
|
DISABLED = "DISABLED",
|
|
3601
3602
|
PENDING = "PENDING",
|
|
3602
3603
|
DEMO = "DEMO"
|
|
3603
3604
|
}
|
|
3604
|
-
interface SiteCreated {
|
|
3605
|
+
export interface SiteCreated {
|
|
3605
3606
|
/**
|
|
3606
3607
|
* A template identifier (empty if not created from a template).
|
|
3607
3608
|
* @maxLength 36
|
|
@@ -3630,7 +3631,7 @@ interface SiteCreated {
|
|
|
3630
3631
|
/** A namespace. */
|
|
3631
3632
|
namespace?: Namespace;
|
|
3632
3633
|
}
|
|
3633
|
-
declare enum SiteCreatedContext {
|
|
3634
|
+
export declare enum SiteCreatedContext {
|
|
3634
3635
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
3635
3636
|
OTHER = "OTHER",
|
|
3636
3637
|
/** A meta site was created from template. */
|
|
@@ -3644,7 +3645,7 @@ declare enum SiteCreatedContext {
|
|
|
3644
3645
|
/** deprecated A meta site was created for Flash editor. */
|
|
3645
3646
|
FLASH = "FLASH"
|
|
3646
3647
|
}
|
|
3647
|
-
declare enum Namespace {
|
|
3648
|
+
export declare enum Namespace {
|
|
3648
3649
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
3649
3650
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
3650
3651
|
WIX = "WIX",
|
|
@@ -3723,7 +3724,7 @@ declare enum Namespace {
|
|
|
3723
3724
|
STANDALONE_FORMS = "STANDALONE_FORMS"
|
|
3724
3725
|
}
|
|
3725
3726
|
/** Site transferred to another user. */
|
|
3726
|
-
interface SiteTransferred {
|
|
3727
|
+
export interface SiteTransferred {
|
|
3727
3728
|
/**
|
|
3728
3729
|
* A previous owner id (user that transfers meta site).
|
|
3729
3730
|
* @format GUID
|
|
@@ -3736,11 +3737,11 @@ interface SiteTransferred {
|
|
|
3736
3737
|
newOwnerId?: string;
|
|
3737
3738
|
}
|
|
3738
3739
|
/** Soft deletion of the meta site. Could be restored. */
|
|
3739
|
-
interface SiteDeleted {
|
|
3740
|
+
export interface SiteDeleted {
|
|
3740
3741
|
/** A deletion context. */
|
|
3741
3742
|
deleteContext?: DeleteContext;
|
|
3742
3743
|
}
|
|
3743
|
-
interface DeleteContext {
|
|
3744
|
+
export interface DeleteContext {
|
|
3744
3745
|
/** When the meta site was deleted. */
|
|
3745
3746
|
dateDeleted?: Date | null;
|
|
3746
3747
|
/** A status. */
|
|
@@ -3756,7 +3757,7 @@ interface DeleteContext {
|
|
|
3756
3757
|
*/
|
|
3757
3758
|
initiatorId?: string | null;
|
|
3758
3759
|
}
|
|
3759
|
-
declare enum DeleteStatus {
|
|
3760
|
+
export declare enum DeleteStatus {
|
|
3760
3761
|
UNKNOWN = "UNKNOWN",
|
|
3761
3762
|
TRASH = "TRASH",
|
|
3762
3763
|
DELETED = "DELETED",
|
|
@@ -3764,12 +3765,12 @@ declare enum DeleteStatus {
|
|
|
3764
3765
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
3765
3766
|
}
|
|
3766
3767
|
/** Restoration of the meta site. */
|
|
3767
|
-
interface SiteUndeleted {
|
|
3768
|
+
export interface SiteUndeleted {
|
|
3768
3769
|
}
|
|
3769
3770
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
3770
|
-
interface SitePublished {
|
|
3771
|
+
export interface SitePublished {
|
|
3771
3772
|
}
|
|
3772
|
-
interface SiteUnpublished {
|
|
3773
|
+
export interface SiteUnpublished {
|
|
3773
3774
|
/**
|
|
3774
3775
|
* A list of URLs previously associated with the meta site.
|
|
3775
3776
|
* @maxLength 4000
|
|
@@ -3777,9 +3778,9 @@ interface SiteUnpublished {
|
|
|
3777
3778
|
*/
|
|
3778
3779
|
urls?: string[];
|
|
3779
3780
|
}
|
|
3780
|
-
interface SiteMarkedAsTemplate {
|
|
3781
|
+
export interface SiteMarkedAsTemplate {
|
|
3781
3782
|
}
|
|
3782
|
-
interface SiteMarkedAsWixSite {
|
|
3783
|
+
export interface SiteMarkedAsWixSite {
|
|
3783
3784
|
}
|
|
3784
3785
|
/**
|
|
3785
3786
|
* Represents a service provisioned a site.
|
|
@@ -3796,7 +3797,7 @@ interface SiteMarkedAsWixSite {
|
|
|
3796
3797
|
* changes made to the original template afterward.
|
|
3797
3798
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
3798
3799
|
*/
|
|
3799
|
-
interface ServiceProvisioned {
|
|
3800
|
+
export interface ServiceProvisioned {
|
|
3800
3801
|
/**
|
|
3801
3802
|
* Either UUID or EmbeddedServiceType.
|
|
3802
3803
|
* @maxLength 36
|
|
@@ -3823,7 +3824,7 @@ interface ServiceProvisioned {
|
|
|
3823
3824
|
*/
|
|
3824
3825
|
originMetaSiteId?: string | null;
|
|
3825
3826
|
}
|
|
3826
|
-
interface ServiceRemoved {
|
|
3827
|
+
export interface ServiceRemoved {
|
|
3827
3828
|
/**
|
|
3828
3829
|
* Either UUID or EmbeddedServiceType.
|
|
3829
3830
|
* @maxLength 36
|
|
@@ -3841,7 +3842,7 @@ interface ServiceRemoved {
|
|
|
3841
3842
|
version?: string | null;
|
|
3842
3843
|
}
|
|
3843
3844
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
3844
|
-
interface SiteRenamed {
|
|
3845
|
+
export interface SiteRenamed {
|
|
3845
3846
|
/**
|
|
3846
3847
|
* A new meta site name (URL slug).
|
|
3847
3848
|
* @maxLength 20
|
|
@@ -3858,23 +3859,23 @@ interface SiteRenamed {
|
|
|
3858
3859
|
*
|
|
3859
3860
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
3860
3861
|
*/
|
|
3861
|
-
interface SiteHardDeleted {
|
|
3862
|
+
export interface SiteHardDeleted {
|
|
3862
3863
|
/** A deletion context. */
|
|
3863
3864
|
deleteContext?: DeleteContext;
|
|
3864
3865
|
}
|
|
3865
|
-
interface NamespaceChanged {
|
|
3866
|
+
export interface NamespaceChanged {
|
|
3866
3867
|
/** A previous namespace. */
|
|
3867
3868
|
oldNamespace?: Namespace;
|
|
3868
3869
|
/** A new namespace. */
|
|
3869
3870
|
newNamespace?: Namespace;
|
|
3870
3871
|
}
|
|
3871
3872
|
/** Assigned Studio editor */
|
|
3872
|
-
interface StudioAssigned {
|
|
3873
|
+
export interface StudioAssigned {
|
|
3873
3874
|
}
|
|
3874
3875
|
/** Unassigned Studio editor */
|
|
3875
|
-
interface StudioUnassigned {
|
|
3876
|
+
export interface StudioUnassigned {
|
|
3876
3877
|
}
|
|
3877
|
-
interface GetTicketDefinitionFromTrashBinRequest {
|
|
3878
|
+
export interface GetTicketDefinitionFromTrashBinRequest {
|
|
3878
3879
|
/**
|
|
3879
3880
|
* Ticket definition ID.
|
|
3880
3881
|
* @format GUID
|
|
@@ -3886,18 +3887,18 @@ interface GetTicketDefinitionFromTrashBinRequest {
|
|
|
3886
3887
|
*/
|
|
3887
3888
|
fields?: Field[];
|
|
3888
3889
|
}
|
|
3889
|
-
interface GetTicketDefinitionFromTrashBinResponse {
|
|
3890
|
+
export interface GetTicketDefinitionFromTrashBinResponse {
|
|
3890
3891
|
/** The requested ticket definition. */
|
|
3891
3892
|
ticketDefinition?: TicketDefinition;
|
|
3892
3893
|
}
|
|
3893
|
-
interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3894
|
+
export interface ScheduleLegacyTimeCapsuleTaskRequest {
|
|
3894
3895
|
/**
|
|
3895
3896
|
* Definition ID.
|
|
3896
3897
|
* @format GUID
|
|
3897
3898
|
*/
|
|
3898
3899
|
ticketDefinitionId?: string;
|
|
3899
3900
|
}
|
|
3900
|
-
interface MessageEnvelope {
|
|
3901
|
+
export interface MessageEnvelope {
|
|
3901
3902
|
/**
|
|
3902
3903
|
* App instance ID.
|
|
3903
3904
|
* @format GUID
|
|
@@ -3913,7 +3914,7 @@ interface MessageEnvelope {
|
|
|
3913
3914
|
/** Stringify payload. */
|
|
3914
3915
|
data?: string;
|
|
3915
3916
|
}
|
|
3916
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3917
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3917
3918
|
/**
|
|
3918
3919
|
* ID of a site visitor that has not logged in to the site.
|
|
3919
3920
|
* @format GUID
|
|
@@ -3938,7 +3939,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3938
3939
|
identityType?: WebhookIdentityType;
|
|
3939
3940
|
}
|
|
3940
3941
|
/** @oneof */
|
|
3941
|
-
interface IdentificationDataIdOneOf {
|
|
3942
|
+
export interface IdentificationDataIdOneOf {
|
|
3942
3943
|
/**
|
|
3943
3944
|
* ID of a site visitor that has not logged in to the site.
|
|
3944
3945
|
* @format GUID
|
|
@@ -3960,25 +3961,25 @@ interface IdentificationDataIdOneOf {
|
|
|
3960
3961
|
*/
|
|
3961
3962
|
appId?: string;
|
|
3962
3963
|
}
|
|
3963
|
-
declare enum WebhookIdentityType {
|
|
3964
|
+
export declare enum WebhookIdentityType {
|
|
3964
3965
|
UNKNOWN = "UNKNOWN",
|
|
3965
3966
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
3966
3967
|
MEMBER = "MEMBER",
|
|
3967
3968
|
WIX_USER = "WIX_USER",
|
|
3968
3969
|
APP = "APP"
|
|
3969
3970
|
}
|
|
3970
|
-
interface GetTicketDefinitionSummaryRequest {
|
|
3971
|
+
export interface GetTicketDefinitionSummaryRequest {
|
|
3971
3972
|
/**
|
|
3972
3973
|
* Ticket definition id.
|
|
3973
3974
|
* @format GUID
|
|
3974
3975
|
*/
|
|
3975
3976
|
ticketDefinitionId?: string | null;
|
|
3976
3977
|
}
|
|
3977
|
-
interface GetTicketDefinitionSummaryResponse {
|
|
3978
|
+
export interface GetTicketDefinitionSummaryResponse {
|
|
3978
3979
|
/** Summary. */
|
|
3979
3980
|
summary?: TicketDefinitionSummary;
|
|
3980
3981
|
}
|
|
3981
|
-
interface TicketDefinitionSummary {
|
|
3982
|
+
export interface TicketDefinitionSummary {
|
|
3982
3983
|
/**
|
|
3983
3984
|
* Ticket definition ID.
|
|
3984
3985
|
* @format GUID
|
|
@@ -4012,7 +4013,7 @@ interface TicketDefinitionSummary {
|
|
|
4012
4013
|
*/
|
|
4013
4014
|
paidExists?: boolean;
|
|
4014
4015
|
}
|
|
4015
|
-
interface ListEventTicketingSummaryRequest {
|
|
4016
|
+
export interface ListEventTicketingSummaryRequest {
|
|
4016
4017
|
/**
|
|
4017
4018
|
* Event ID.
|
|
4018
4019
|
* @format GUID
|
|
@@ -4021,11 +4022,11 @@ interface ListEventTicketingSummaryRequest {
|
|
|
4021
4022
|
*/
|
|
4022
4023
|
eventId?: string[];
|
|
4023
4024
|
}
|
|
4024
|
-
interface ListEventTicketingSummaryResponse {
|
|
4025
|
+
export interface ListEventTicketingSummaryResponse {
|
|
4025
4026
|
/** Ticketing summaries. */
|
|
4026
4027
|
summaries?: EventTicketingSummary[];
|
|
4027
4028
|
}
|
|
4028
|
-
interface EventTicketingSummary {
|
|
4029
|
+
export interface EventTicketingSummary {
|
|
4029
4030
|
/**
|
|
4030
4031
|
* Event ID to which the ticketing summary belongs.
|
|
4031
4032
|
* @format GUID
|
|
@@ -4072,7 +4073,7 @@ interface EventTicketingSummary {
|
|
|
4072
4073
|
*/
|
|
4073
4074
|
highestTicketPriceFormatted?: string | null;
|
|
4074
4075
|
}
|
|
4075
|
-
interface ReservationCreated {
|
|
4076
|
+
export interface ReservationCreated {
|
|
4076
4077
|
/** Reservation created timestamp in ISO UTC format. */
|
|
4077
4078
|
timestamp?: Date | null;
|
|
4078
4079
|
/**
|
|
@@ -4103,7 +4104,7 @@ interface ReservationCreated {
|
|
|
4103
4104
|
*/
|
|
4104
4105
|
counts?: ReservationCount[];
|
|
4105
4106
|
}
|
|
4106
|
-
declare enum ReservationStatus {
|
|
4107
|
+
export declare enum ReservationStatus {
|
|
4107
4108
|
/** The Reservation is pending confirmation and will expire after the expiration due time. */
|
|
4108
4109
|
RESERVATION_PENDING = "RESERVATION_PENDING",
|
|
4109
4110
|
/** The reservation is confirmed and will not expire. */
|
|
@@ -4115,7 +4116,7 @@ declare enum ReservationStatus {
|
|
|
4115
4116
|
/** The reservation is expired. */
|
|
4116
4117
|
RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
|
|
4117
4118
|
}
|
|
4118
|
-
interface TicketQuantity {
|
|
4119
|
+
export interface TicketQuantity {
|
|
4119
4120
|
/**
|
|
4120
4121
|
* Ticket definition ID.
|
|
4121
4122
|
* @format GUID
|
|
@@ -4126,7 +4127,7 @@ interface TicketQuantity {
|
|
|
4126
4127
|
/** Quantity update timestamp. */
|
|
4127
4128
|
_updatedDate?: Date | null;
|
|
4128
4129
|
}
|
|
4129
|
-
interface ReservationCount {
|
|
4130
|
+
export interface ReservationCount {
|
|
4130
4131
|
/** Reservation Count snapshot timestamp. */
|
|
4131
4132
|
timestamp?: Date | null;
|
|
4132
4133
|
/**
|
|
@@ -4141,7 +4142,7 @@ interface ReservationCount {
|
|
|
4141
4142
|
/** True if paid ticket reservation exist. */
|
|
4142
4143
|
paidExists?: boolean;
|
|
4143
4144
|
}
|
|
4144
|
-
interface ReservationUpdated {
|
|
4145
|
+
export interface ReservationUpdated {
|
|
4145
4146
|
/** Reservation updated timestamp. */
|
|
4146
4147
|
timestamp?: Date | null;
|
|
4147
4148
|
/**
|
|
@@ -4172,7 +4173,7 @@ interface ReservationUpdated {
|
|
|
4172
4173
|
*/
|
|
4173
4174
|
counts?: ReservationCount[];
|
|
4174
4175
|
}
|
|
4175
|
-
interface BaseEventMetadata {
|
|
4176
|
+
export interface BaseEventMetadata {
|
|
4176
4177
|
/**
|
|
4177
4178
|
* App instance ID.
|
|
4178
4179
|
* @format GUID
|
|
@@ -4186,7 +4187,7 @@ interface BaseEventMetadata {
|
|
|
4186
4187
|
/** The identification type and identity data. */
|
|
4187
4188
|
identity?: IdentificationData;
|
|
4188
4189
|
}
|
|
4189
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
4190
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
4190
4191
|
/**
|
|
4191
4192
|
* Unique event ID.
|
|
4192
4193
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -4224,37 +4225,189 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
4224
4225
|
*/
|
|
4225
4226
|
entityEventSequence?: string | null;
|
|
4226
4227
|
}
|
|
4227
|
-
interface TicketDefinitionCreatedEnvelope {
|
|
4228
|
+
export interface TicketDefinitionCreatedEnvelope {
|
|
4228
4229
|
entity: TicketDefinition;
|
|
4229
4230
|
metadata: EventMetadata;
|
|
4230
4231
|
}
|
|
4231
|
-
|
|
4232
|
+
/**
|
|
4233
|
+
* Triggered when a ticket definition is created.
|
|
4234
|
+
* @permissionScope Manage Events - all permissions
|
|
4235
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4236
|
+
* @permissionScope Manage Events
|
|
4237
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4238
|
+
* @permissionScope Manage Orders
|
|
4239
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4240
|
+
* @permissionScope Manage Ticket Definitions
|
|
4241
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4242
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4243
|
+
* @webhook
|
|
4244
|
+
* @eventType wix.events.v3.ticket_definition_created
|
|
4245
|
+
* @slug created
|
|
4246
|
+
*/
|
|
4247
|
+
export declare function onTicketDefinitionCreated(handler: (event: TicketDefinitionCreatedEnvelope) => void | Promise<void>): void;
|
|
4248
|
+
export interface TicketDefinitionDeletedEnvelope {
|
|
4232
4249
|
metadata: EventMetadata;
|
|
4233
4250
|
}
|
|
4234
|
-
|
|
4251
|
+
/**
|
|
4252
|
+
* Triggered when a ticket definition is deleted.
|
|
4253
|
+
* @permissionScope Manage Events - all permissions
|
|
4254
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4255
|
+
* @permissionScope Manage Events
|
|
4256
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4257
|
+
* @permissionScope Manage Orders
|
|
4258
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4259
|
+
* @permissionScope Manage Ticket Definitions
|
|
4260
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4261
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4262
|
+
* @webhook
|
|
4263
|
+
* @eventType wix.events.v3.ticket_definition_deleted
|
|
4264
|
+
* @slug deleted
|
|
4265
|
+
*/
|
|
4266
|
+
export declare function onTicketDefinitionDeleted(handler: (event: TicketDefinitionDeletedEnvelope) => void | Promise<void>): void;
|
|
4267
|
+
export interface TicketDefinitionSaleEndedEnvelope {
|
|
4235
4268
|
data: TicketDefinitionSaleEnded;
|
|
4236
4269
|
metadata: EventMetadata;
|
|
4237
4270
|
}
|
|
4238
|
-
|
|
4271
|
+
/**
|
|
4272
|
+
* Triggered when a ticket sale ends. Sales details are not included in the payload.
|
|
4273
|
+
* @permissionScope Manage Events - all permissions
|
|
4274
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4275
|
+
* @permissionScope Manage Events
|
|
4276
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4277
|
+
* @permissionScope Manage Orders
|
|
4278
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4279
|
+
* @permissionScope Manage Ticket Definitions
|
|
4280
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4281
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4282
|
+
* @webhook
|
|
4283
|
+
* @eventType wix.events.v3.ticket_definition_sale_ended
|
|
4284
|
+
* @slug sale_ended
|
|
4285
|
+
*/
|
|
4286
|
+
export declare function onTicketDefinitionSaleEnded(handler: (event: TicketDefinitionSaleEndedEnvelope) => void | Promise<void>): void;
|
|
4287
|
+
export interface TicketDefinitionSalePeriodUpdatedEnvelope {
|
|
4239
4288
|
data: SalePeriodUpdated;
|
|
4240
4289
|
metadata: EventMetadata;
|
|
4241
4290
|
}
|
|
4242
|
-
|
|
4291
|
+
/**
|
|
4292
|
+
* Triggered when a sale period is updated.
|
|
4293
|
+
* @permissionScope Manage Events - all permissions
|
|
4294
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4295
|
+
* @permissionScope Manage Events
|
|
4296
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4297
|
+
* @permissionScope Manage Orders
|
|
4298
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4299
|
+
* @permissionScope Manage Ticket Definitions
|
|
4300
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4301
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4302
|
+
* @webhook
|
|
4303
|
+
* @eventType wix.events.v3.ticket_definition_sale_period_updated
|
|
4304
|
+
* @slug sale_period_updated
|
|
4305
|
+
*/
|
|
4306
|
+
export declare function onTicketDefinitionSalePeriodUpdated(handler: (event: TicketDefinitionSalePeriodUpdatedEnvelope) => void | Promise<void>): void;
|
|
4307
|
+
export interface TicketDefinitionSaleStartedEnvelope {
|
|
4243
4308
|
data: TicketDefinitionSaleStarted;
|
|
4244
4309
|
metadata: EventMetadata;
|
|
4245
4310
|
}
|
|
4246
|
-
|
|
4311
|
+
/**
|
|
4312
|
+
* Triggered when a ticket sale starts. Sales details are not included in the payload.
|
|
4313
|
+
* @permissionScope Manage Events - all permissions
|
|
4314
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4315
|
+
* @permissionScope Manage Events
|
|
4316
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4317
|
+
* @permissionScope Manage Orders
|
|
4318
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4319
|
+
* @permissionScope Manage Ticket Definitions
|
|
4320
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4321
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4322
|
+
* @webhook
|
|
4323
|
+
* @eventType wix.events.v3.ticket_definition_sale_started
|
|
4324
|
+
* @slug sale_started
|
|
4325
|
+
*/
|
|
4326
|
+
export declare function onTicketDefinitionSaleStarted(handler: (event: TicketDefinitionSaleStartedEnvelope) => void | Promise<void>): void;
|
|
4327
|
+
export interface TicketDefinitionUpdatedEnvelope {
|
|
4247
4328
|
entity: TicketDefinition;
|
|
4248
4329
|
metadata: EventMetadata;
|
|
4249
4330
|
}
|
|
4250
|
-
|
|
4331
|
+
/**
|
|
4332
|
+
* Triggered when a ticket definition is updated.
|
|
4333
|
+
* @permissionScope Manage Events - all permissions
|
|
4334
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4335
|
+
* @permissionScope Manage Events
|
|
4336
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4337
|
+
* @permissionScope Manage Orders
|
|
4338
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4339
|
+
* @permissionScope Manage Ticket Definitions
|
|
4340
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4341
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4342
|
+
* @webhook
|
|
4343
|
+
* @eventType wix.events.v3.ticket_definition_updated
|
|
4344
|
+
* @slug updated
|
|
4345
|
+
*/
|
|
4346
|
+
export declare function onTicketDefinitionUpdated(handler: (event: TicketDefinitionUpdatedEnvelope) => void | Promise<void>): void;
|
|
4347
|
+
type TicketDefinitionNonNullablePaths = `hidden` | `limited` | `pricingMethod.fixedPrice.value` | `pricingMethod.fixedPrice.currency` | `pricingMethod.pricingOptions.optionDetails` | `pricingMethod.pricingType` | `pricingMethod.free` | `feeType` | `salePeriod.displayNotOnSale` | `saleStatus` | `eventDetails.location.type` | `eventDetails.location.address.streetAddress.number` | `eventDetails.location.address.streetAddress.name` | `eventDetails.dateAndTimeSettings.recurrenceStatus` | `eventDetails.dateAndTimeSettings.recurringEvents.individualEventDates` | `eventDetails.dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `eventDetails.status`;
|
|
4348
|
+
/**
|
|
4349
|
+
* > **Note:** This function replaces the deprecated `createTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/createticketdefinition).
|
|
4350
|
+
*
|
|
4351
|
+
*
|
|
4352
|
+
* Creates a ticket definition.
|
|
4353
|
+
*
|
|
4354
|
+
*
|
|
4355
|
+
* It is allowed to create up to 100 definitions per event.
|
|
4356
|
+
* @param ticketDefinition - Ticket definition info.
|
|
4357
|
+
* @public
|
|
4358
|
+
* @requiredField ticketDefinition
|
|
4359
|
+
* @requiredField ticketDefinition.eventId
|
|
4360
|
+
* @requiredField ticketDefinition.feeType
|
|
4361
|
+
* @requiredField ticketDefinition.name
|
|
4362
|
+
* @requiredField ticketDefinition.pricingMethod
|
|
4363
|
+
* @requiredField ticketDefinition.pricingMethod.price
|
|
4364
|
+
* @param options - Optional fields.
|
|
4365
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4366
|
+
* @permissionScope Manage Events - all permissions
|
|
4367
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4368
|
+
* @permissionScope Manage Events
|
|
4369
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4370
|
+
* @permissionScope Manage Ticket Definitions
|
|
4371
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4372
|
+
* @applicableIdentity APP
|
|
4373
|
+
* @returns Created ticket definition.
|
|
4374
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.CreateTicketDefinition
|
|
4375
|
+
*/
|
|
4376
|
+
export declare function createTicketDefinition(ticketDefinition: NonNullablePaths<TicketDefinition, `eventId` | `feeType` | `name` | `pricingMethod`>, options?: CreateTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
4377
|
+
export interface CreateTicketDefinitionOptions {
|
|
4251
4378
|
/**
|
|
4252
4379
|
* Predefined sets of fields to return.
|
|
4253
4380
|
* @maxSize 5
|
|
4254
4381
|
*/
|
|
4255
4382
|
fields?: Field[];
|
|
4256
4383
|
}
|
|
4257
|
-
|
|
4384
|
+
/**
|
|
4385
|
+
* > **Note:** This function replaces the deprecated `updateTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/updateticketdefinition).
|
|
4386
|
+
*
|
|
4387
|
+
* Updates a ticket definition.
|
|
4388
|
+
*
|
|
4389
|
+
*
|
|
4390
|
+
* Each time the ticket definition is updated, `revision` increments by 1. The existing `revision` must be included when updating the ticket definition. This ensures you're working with the latest ticket definition and prevents unintended overwrites.
|
|
4391
|
+
* @param _id - Ticket definition ID.
|
|
4392
|
+
* @public
|
|
4393
|
+
* @requiredField _id
|
|
4394
|
+
* @requiredField ticketDefinition
|
|
4395
|
+
* @requiredField ticketDefinition.revision
|
|
4396
|
+
* @param options - Optional fields.
|
|
4397
|
+
* @param ticketDefinition - Ticket definition to update.
|
|
4398
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4399
|
+
* @permissionScope Manage Events - all permissions
|
|
4400
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4401
|
+
* @permissionScope Manage Events
|
|
4402
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4403
|
+
* @permissionScope Manage Ticket Definitions
|
|
4404
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4405
|
+
* @applicableIdentity APP
|
|
4406
|
+
* @returns The updated ticket definition.
|
|
4407
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.UpdateTicketDefinition
|
|
4408
|
+
*/
|
|
4409
|
+
export declare function updateTicketDefinition(_id: string, ticketDefinition: NonNullablePaths<UpdateTicketDefinition, `revision`>, options?: UpdateTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
4410
|
+
export interface UpdateTicketDefinition {
|
|
4258
4411
|
/**
|
|
4259
4412
|
* Ticket definition ID.
|
|
4260
4413
|
* @format GUID
|
|
@@ -4343,21 +4496,80 @@ interface UpdateTicketDefinition {
|
|
|
4343
4496
|
*/
|
|
4344
4497
|
eventDetails?: EventDetails;
|
|
4345
4498
|
}
|
|
4346
|
-
interface UpdateTicketDefinitionOptions {
|
|
4499
|
+
export interface UpdateTicketDefinitionOptions {
|
|
4347
4500
|
/**
|
|
4348
4501
|
* Predefined sets of fields to return.
|
|
4349
4502
|
* @maxSize 5
|
|
4350
4503
|
*/
|
|
4351
4504
|
fields?: Field[];
|
|
4352
4505
|
}
|
|
4353
|
-
|
|
4506
|
+
/**
|
|
4507
|
+
* > **Note:** This function replaces the deprecated `getTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/getticketdefinition).
|
|
4508
|
+
*
|
|
4509
|
+
* Retrieves a ticket definition by ID.
|
|
4510
|
+
* @param ticketDefinitionId - Ticket definition ID.
|
|
4511
|
+
* @public
|
|
4512
|
+
* @requiredField ticketDefinitionId
|
|
4513
|
+
* @param options - Optional fields.
|
|
4514
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4515
|
+
* @permissionScope Manage Events - all permissions
|
|
4516
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4517
|
+
* @permissionScope Manage Events
|
|
4518
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4519
|
+
* @permissionScope Manage Orders
|
|
4520
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4521
|
+
* @permissionScope Manage Ticket Definitions
|
|
4522
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4523
|
+
* @applicableIdentity APP
|
|
4524
|
+
* @returns The requested ticket definition.
|
|
4525
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.GetTicketDefinition
|
|
4526
|
+
*/
|
|
4527
|
+
export declare function getTicketDefinition(ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise<NonNullablePaths<TicketDefinition, TicketDefinitionNonNullablePaths>>;
|
|
4528
|
+
export interface GetTicketDefinitionOptions {
|
|
4354
4529
|
/**
|
|
4355
4530
|
* Predefined sets of fields to return.
|
|
4356
4531
|
* @maxSize 5
|
|
4357
4532
|
*/
|
|
4358
4533
|
fields?: Field[];
|
|
4359
4534
|
}
|
|
4360
|
-
|
|
4535
|
+
/**
|
|
4536
|
+
* > **Note:** This function replaces the deprecated `deleteTicketDefinition()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/deleteticketdefinition).
|
|
4537
|
+
*
|
|
4538
|
+
* Permanently deletes a ticket definition.
|
|
4539
|
+
* @param ticketDefinitionId - ID of the ticket definition to delete.
|
|
4540
|
+
* @public
|
|
4541
|
+
* @requiredField ticketDefinitionId
|
|
4542
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4543
|
+
* @permissionScope Manage Events - all permissions
|
|
4544
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4545
|
+
* @permissionScope Manage Events
|
|
4546
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4547
|
+
* @permissionScope Manage Ticket Definitions
|
|
4548
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4549
|
+
* @applicableIdentity APP
|
|
4550
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.DeleteTicketDefinition
|
|
4551
|
+
*/
|
|
4552
|
+
export declare function deleteTicketDefinition(ticketDefinitionId: string): Promise<void>;
|
|
4553
|
+
/**
|
|
4554
|
+
* Changes ticket definitions order in an event dashboard and the list of available tickets in the ticket picker.
|
|
4555
|
+
* > **Note:** It is possible to use both `beforeTicketDefinitionId` and `afterTicketDefinitionId` at the same time but only the last one defined will be executed.
|
|
4556
|
+
* @param eventId - Event ID.
|
|
4557
|
+
* @public
|
|
4558
|
+
* @requiredField eventId
|
|
4559
|
+
* @requiredField options.ticketDefinitionId
|
|
4560
|
+
* @param options - Optional fields.
|
|
4561
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4562
|
+
* @permissionScope Manage Events - all permissions
|
|
4563
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4564
|
+
* @permissionScope Manage Events
|
|
4565
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4566
|
+
* @permissionScope Manage Ticket Definitions
|
|
4567
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4568
|
+
* @applicableIdentity APP
|
|
4569
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.ReorderTicketDefinitions
|
|
4570
|
+
*/
|
|
4571
|
+
export declare function reorderTicketDefinitions(eventId: string, options?: NonNullablePaths<ReorderTicketDefinitionsOptions, `ticketDefinitionId`>): Promise<void>;
|
|
4572
|
+
export interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4361
4573
|
/**
|
|
4362
4574
|
* Ticket definition ID.
|
|
4363
4575
|
* @format GUID
|
|
@@ -4375,7 +4587,7 @@ interface ReorderTicketDefinitionsOptions extends ReorderTicketDefinitionsOption
|
|
|
4375
4587
|
afterDefinitionId?: string;
|
|
4376
4588
|
}
|
|
4377
4589
|
/** @oneof */
|
|
4378
|
-
interface ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4590
|
+
export interface ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
4379
4591
|
/**
|
|
4380
4592
|
* Move the given `definitionId` before the referenced ticket definition.
|
|
4381
4593
|
* @format GUID
|
|
@@ -4387,7 +4599,30 @@ interface ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf {
|
|
|
4387
4599
|
*/
|
|
4388
4600
|
afterDefinitionId?: string;
|
|
4389
4601
|
}
|
|
4390
|
-
|
|
4602
|
+
/**
|
|
4603
|
+
* > **Note:** This function replaces the deprecated `listTicketDefinition()` and `queryTicketDefinitions` functions. The deprecated functions will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/queryticketdefinitions).
|
|
4604
|
+
*
|
|
4605
|
+
* Retrieves a list of ticket definitions, given the provided paging, filtering, and sorting.
|
|
4606
|
+
* Query Ticket Definitions runs with these defaults, which you can override:
|
|
4607
|
+
* - `createdDate` is sorted in `ASC` order
|
|
4608
|
+
* - `paging.limit` is `100`
|
|
4609
|
+
* - `paging.offset` is `0`
|
|
4610
|
+
* @public
|
|
4611
|
+
* @param options - Optional fields.
|
|
4612
|
+
* @permissionScope Manage Events - all permissions
|
|
4613
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4614
|
+
* @permissionScope Manage Events
|
|
4615
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4616
|
+
* @permissionScope Manage Orders
|
|
4617
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4618
|
+
* @permissionScope Manage Ticket Definitions
|
|
4619
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4620
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4621
|
+
* @applicableIdentity APP
|
|
4622
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.QueryTicketDefinitions
|
|
4623
|
+
*/
|
|
4624
|
+
export declare function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;
|
|
4625
|
+
export interface QueryTicketDefinitionsOptions {
|
|
4391
4626
|
/**
|
|
4392
4627
|
* Predefined sets of fields to return.
|
|
4393
4628
|
* @maxSize 5
|
|
@@ -4401,13 +4636,13 @@ interface QueryCursorResult {
|
|
|
4401
4636
|
length: number;
|
|
4402
4637
|
pageSize: number;
|
|
4403
4638
|
}
|
|
4404
|
-
interface TicketDefinitionsQueryResult extends QueryCursorResult {
|
|
4639
|
+
export interface TicketDefinitionsQueryResult extends QueryCursorResult {
|
|
4405
4640
|
items: TicketDefinition[];
|
|
4406
4641
|
query: TicketDefinitionsQueryBuilder;
|
|
4407
4642
|
next: () => Promise<TicketDefinitionsQueryResult>;
|
|
4408
4643
|
prev: () => Promise<TicketDefinitionsQueryResult>;
|
|
4409
4644
|
}
|
|
4410
|
-
interface TicketDefinitionsQueryBuilder {
|
|
4645
|
+
export interface TicketDefinitionsQueryBuilder {
|
|
4411
4646
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4412
4647
|
* @param value - Value to compare against.
|
|
4413
4648
|
*/
|
|
@@ -4444,14 +4679,63 @@ interface TicketDefinitionsQueryBuilder {
|
|
|
4444
4679
|
skipTo: (cursor: string) => TicketDefinitionsQueryBuilder;
|
|
4445
4680
|
find: () => Promise<TicketDefinitionsQueryResult>;
|
|
4446
4681
|
}
|
|
4447
|
-
|
|
4682
|
+
/**
|
|
4683
|
+
* Retrieves a list of available ticket definitions, given the provided paging, filtering, and sorting.
|
|
4684
|
+
*
|
|
4685
|
+
* This endpoint retrieves ticket definitions that aren't in the `hidden` state. The available ticket definitions can be retrieved by site visitors.
|
|
4686
|
+
*
|
|
4687
|
+
* > **Note:** You need the `WIX_EVENTS.READ_TICKET_DEFINITIONS` permission to get the `salesDetails` field values.
|
|
4688
|
+
*
|
|
4689
|
+
* Query Available Ticket Definitions runs with these defaults, which you can override:
|
|
4690
|
+
* - `createdDate` is sorted in `ASC` order
|
|
4691
|
+
* - `paging.limit` is `100`
|
|
4692
|
+
* - `paging.offset` is `0`
|
|
4693
|
+
*
|
|
4694
|
+
* For field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/filter-and-sort).
|
|
4695
|
+
* To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
4696
|
+
* @param query - Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details.
|
|
4697
|
+
* @public
|
|
4698
|
+
* @requiredField query
|
|
4699
|
+
* @param options - Optional fields.
|
|
4700
|
+
* @permissionId WIX_EVENTS.READ_AVAILABLE_TICKET_DEFINITIONS
|
|
4701
|
+
* @permissionScope Manage Events - all permissions
|
|
4702
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4703
|
+
* @permissionScope Manage Events
|
|
4704
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4705
|
+
* @permissionScope Manage Orders
|
|
4706
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4707
|
+
* @applicableIdentity APP
|
|
4708
|
+
* @applicableIdentity VISITOR
|
|
4709
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.QueryAvailableTicketDefinitions
|
|
4710
|
+
*/
|
|
4711
|
+
export declare function queryAvailableTicketDefinitions(query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions): Promise<NonNullablePaths<QueryAvailableTicketDefinitionsResponse, {
|
|
4712
|
+
[P in TicketDefinitionNonNullablePaths]: `ticketDefinitions.${number}.${P}`;
|
|
4713
|
+
}[TicketDefinitionNonNullablePaths]>>;
|
|
4714
|
+
export interface QueryAvailableTicketDefinitionsOptions {
|
|
4448
4715
|
/**
|
|
4449
4716
|
* Predefined sets of fields to return.
|
|
4450
4717
|
* @maxSize 5
|
|
4451
4718
|
*/
|
|
4452
4719
|
fields?: Field[];
|
|
4453
4720
|
}
|
|
4454
|
-
|
|
4721
|
+
/**
|
|
4722
|
+
* Counts ticket definitions by the `saleStatus` field, including those with the `hidden` status.
|
|
4723
|
+
* @public
|
|
4724
|
+
* @param options - Optional fields.
|
|
4725
|
+
* @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS
|
|
4726
|
+
* @permissionScope Manage Events - all permissions
|
|
4727
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4728
|
+
* @permissionScope Manage Events
|
|
4729
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4730
|
+
* @permissionScope Manage Orders
|
|
4731
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4732
|
+
* @permissionScope Manage Ticket Definitions
|
|
4733
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4734
|
+
* @applicableIdentity APP
|
|
4735
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.CountTicketDefinitions
|
|
4736
|
+
*/
|
|
4737
|
+
export declare function countTicketDefinitions(options?: CountTicketDefinitionsOptions): Promise<CountTicketDefinitionsResponse>;
|
|
4738
|
+
export interface CountTicketDefinitionsOptions {
|
|
4455
4739
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4456
4740
|
filter?: Record<string, any> | null;
|
|
4457
4741
|
/**
|
|
@@ -4463,11 +4747,66 @@ interface CountTicketDefinitionsOptions {
|
|
|
4463
4747
|
*/
|
|
4464
4748
|
facet?: string[];
|
|
4465
4749
|
}
|
|
4466
|
-
|
|
4750
|
+
/**
|
|
4751
|
+
* Counts ticket definitions by the `saleStatus`, excluding those with the `hidden` status.
|
|
4752
|
+
* @public
|
|
4753
|
+
* @param options - Optional fields.
|
|
4754
|
+
* @permissionId WIX_EVENTS.READ_AVAILABLE_TICKET_DEFINITIONS
|
|
4755
|
+
* @permissionScope Manage Events - all permissions
|
|
4756
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4757
|
+
* @permissionScope Manage Events
|
|
4758
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4759
|
+
* @permissionScope Manage Orders
|
|
4760
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-ORDERS
|
|
4761
|
+
* @applicableIdentity APP
|
|
4762
|
+
* @applicableIdentity VISITOR
|
|
4763
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.CountAvailableTicketDefinitions
|
|
4764
|
+
*/
|
|
4765
|
+
export declare function countAvailableTicketDefinitions(options?: CountAvailableTicketDefinitionsOptions): Promise<CountAvailableTicketDefinitionsResponse>;
|
|
4766
|
+
export interface CountAvailableTicketDefinitionsOptions {
|
|
4467
4767
|
/** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. */
|
|
4468
4768
|
filter?: Record<string, any> | null;
|
|
4469
4769
|
}
|
|
4470
|
-
|
|
4770
|
+
/**
|
|
4771
|
+
* Deletes multiple ticket definitions.
|
|
4772
|
+
*
|
|
4773
|
+
* All ticket definitions that meet the specified `filter` criteria are deleted.
|
|
4774
|
+
* @param filter - Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1" }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "3d3d5c04-ece0-45a8-85f0-11a58edaa192" }`
|
|
4775
|
+
* @public
|
|
4776
|
+
* @requiredField filter
|
|
4777
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4778
|
+
* @permissionScope Manage Events - all permissions
|
|
4779
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4780
|
+
* @permissionScope Manage Events
|
|
4781
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4782
|
+
* @permissionScope Manage Ticket Definitions
|
|
4783
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4784
|
+
* @applicableIdentity APP
|
|
4785
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.BulkDeleteTicketDefinitionsByFilter
|
|
4786
|
+
*/
|
|
4787
|
+
export declare function bulkDeleteTicketDefinitionsByFilter(filter: Record<string, any>): Promise<void>;
|
|
4788
|
+
/**
|
|
4789
|
+
* > **Note:** This function replaces the deprecated `changeCurrency()` function. The deprecated function will continue to work until November 8, 2024, but it will not receive updates. To keep any existing code compatible with future changes, see the [migration instructions](https://www.wix.com/velo/reference/wix-events-v2/ticketdefinitions/changecurrency).
|
|
4790
|
+
*
|
|
4791
|
+
* Changes ticket price currency per event.
|
|
4792
|
+
* @param eventId - Event ID.
|
|
4793
|
+
* @public
|
|
4794
|
+
* @requiredField eventId
|
|
4795
|
+
* @requiredField options
|
|
4796
|
+
* @requiredField options.currency
|
|
4797
|
+
* @param options - Optional fields.
|
|
4798
|
+
* @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS
|
|
4799
|
+
* @permissionScope Manage Events - all permissions
|
|
4800
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
4801
|
+
* @permissionScope Manage Events
|
|
4802
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
4803
|
+
* @permissionScope Manage Ticket Definitions
|
|
4804
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-TICKET-DEF
|
|
4805
|
+
* @applicableIdentity APP
|
|
4806
|
+
* @fqn wix.events.ticketdef.v3.TicketDefinitionManagement.ChangeCurrency
|
|
4807
|
+
*/
|
|
4808
|
+
export declare function changeCurrency(eventId: string, options: NonNullablePaths<ChangeCurrencyOptions, `currency`>): Promise<void>;
|
|
4809
|
+
export interface ChangeCurrencyOptions {
|
|
4471
4810
|
/**
|
|
4472
4811
|
* Ticket price currency in 3-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
|
|
4473
4812
|
* @minLength 3
|
|
@@ -4475,5 +4814,4 @@ interface ChangeCurrencyOptions {
|
|
|
4475
4814
|
*/
|
|
4476
4815
|
currency: string;
|
|
4477
4816
|
}
|
|
4478
|
-
|
|
4479
|
-
export { Source as $, Target as A, ButtonDataType as B, type CreateTicketDefinitionOptions as C, TextAlignment as D, EventsRecurrenceStatusStatus as E, FeeTypeEnumType as F, type GetTicketDefinitionOptions as G, LineStyle as H, InputControlType as I, Width as J, Alignment as K, LocationType as L, ViewMode as M, NodeType as N, LayoutType as O, PricingTypeEnumType as P, type QueryTicketDefinitionsOptions as Q, type ReorderTicketDefinitionsOptions as R, SaleStatusEnumStatus as S, type TicketDefinition as T, type UpdateTicketDefinition as U, VisitorType as V, WidthType as W, Orientation as X, Crop as Y, ThumbnailsAlignment as Z, GIFType as _, type UpdateTicketDefinitionOptions as a, type QueryV2PagingMethodOneOf as a$, Position as a0, MapType as a1, ViewRole as a2, VoteRole as a3, PollLayoutType as a4, PollLayoutDirection as a5, BackgroundType as a6, DecorationType as a7, FontType as a8, AppType as a9, type DateAndTimeSettings as aA, type Recurrences as aB, type Occurrence as aC, type Formatted as aD, type InvalidateCache as aE, type InvalidateCacheGetByOneOf as aF, type App as aG, type Page as aH, type URI as aI, type File as aJ, type SalePeriodUpdated as aK, type TicketDefinitionSaleStarted as aL, type TicketDefinitionSaleEnded as aM, type CreateTicketDefinitionRequest as aN, type CreateTicketDefinitionResponse as aO, type UpdateTicketDefinitionRequest as aP, type UpdateTicketDefinitionResponse as aQ, type GetTicketDefinitionRequest as aR, type GetTicketDefinitionResponse as aS, type DeleteTicketDefinitionRequest as aT, type DeleteTicketDefinitionResponse as aU, type ReorderTicketDefinitionsRequest as aV, type ReorderTicketDefinitionsRequestReferenceDefinitionOneOf as aW, type ReorderTicketDefinitionsResponse as aX, type UpdateTicketDefinitionSortIndexRequest as aY, type UpdateTicketDefinitionSortIndexResponse as aZ, type QueryTicketDefinitionsRequest as a_, InitialExpandedItems as aa, Direction as ab, VerticalAlignment as ac, NullValue as ad, Type as ae, State as af, SiteCreatedContext as ag, Namespace as ah, DeleteStatus as ai, WebhookIdentityType as aj, ReservationStatus as ak, type SalePeriod as al, type PricingMethod as am, type PricingMethodPriceOneOf as an, type CommonMoney as ao, type PricingOptions as ap, type OptionDetails as aq, type SalesDetails as ar, type ExtendedFields as as, type EventDetails as at, type Location as au, type CommonAddress as av, type CommonAddressStreetOneOf as aw, type CommonStreetAddress as ax, type CommonAddressLocation as ay, type CommonSubdivision as az, type TicketDefinitionsQueryBuilder as b, type RsvpSummary as b$, type Sorting as b0, type Paging as b1, type CursorPaging as b2, type QueryTicketDefinitionsResponse as b3, type PagingMetadataV2 as b4, type Cursors as b5, type QueryAvailableTicketDefinitionsRequest as b6, type CountTicketDefinitionsRequest as b7, type FacetCounts as b8, type CountAvailableTicketDefinitionsRequest as b9, type Registration as bA, type RsvpCollection as bB, type RsvpCollectionConfig as bC, type Ticketing as bD, type TicketingConfig as bE, type TaxConfig as bF, type Money as bG, type ExternalEvent as bH, type CalendarLinks as bI, type SiteUrl as bJ, type Form as bK, type InputControl as bL, type Input as bM, type OptionSelection as bN, type OptionSelectionSelectedOptionOneOf as bO, type Label as bP, type FormMessages as bQ, type RsvpFormMessages as bR, type PositiveResponseConfirmation as bS, type NegativeResponseConfirmation as bT, type Positive as bU, type Negative as bV, type CheckoutFormMessages as bW, type ResponseConfirmation as bX, type RegistrationClosedMessages as bY, type TicketsUnavailableMessages as bZ, type Dashboard as b_, type BulkDeleteTicketDefinitionsByFilterRequest as ba, type BulkDeleteTicketDefinitionsByFilterResponse as bb, type ChangeCurrencyRequest as bc, type ChangeCurrencyResponse as bd, type BulkCopyTicketDefinitionsByEventIdRequest as be, type BulkCopyTicketDefinitionsByEventIdResponse as bf, type CopiedTicketDefinition as bg, type UpdateFeeTypesBasedOnSettingsRequest as bh, type UpdateFeeTypesBasedOnSettingsResponse as bi, type EventDeleted as bj, type Empty as bk, type EventCanceled as bl, type EventEnded as bm, type EventCreated as bn, type EventsLocation as bo, type MapCoordinates as bp, type Address as bq, type AddressStreetOneOf as br, type StreetAddress as bs, type AddressLocation as bt, type Subdivision as bu, type ScheduleConfig as bv, type EventsRecurrences as bw, type EventsOccurrence as bx, type Event as by, type Scheduling as bz, type QueryV2 as c, type Permissions as c$, type TicketingSummary as c0, type GuestListConfig as c1, type Feed as c2, type OnlineConferencing as c3, type OnlineConferencingConfig as c4, type OnlineConferencingSession as c5, type SeoSettings as c6, type SeoSchema as c7, type Keyword as c8, type Tag as c9, type FileSource as cA, type FileSourceDataOneOf as cB, type PDFSettings as cC, type GalleryData as cD, type Media as cE, type Image as cF, type Video as cG, type Item as cH, type ItemDataOneOf as cI, type GalleryOptions as cJ, type Layout as cK, type ItemStyle as cL, type Thumbnails as cM, type GIFData as cN, type GIF as cO, type HeadingData as cP, type HTMLData as cQ, type HTMLDataDataOneOf as cR, type ImageData as cS, type StylesBorder as cT, type ImageDataStyles as cU, type LinkPreviewData as cV, type LinkPreviewDataStyles as cW, type MapData as cX, type MapSettings as cY, type ParagraphData as cZ, type PollData as c_, type Settings as ca, type Agenda as cb, type Category as cc, type CategoryCounts as cd, type EventDisplaySettings as ce, type LabellingSettings as cf, type RichContent as cg, type Node as ch, type NodeDataOneOf as ci, type NodeStyle as cj, type ButtonData as ck, type Border as cl, type Colors as cm, type PluginContainerData as cn, type PluginContainerDataWidth as co, type PluginContainerDataWidthDataOneOf as cp, type Spoiler as cq, type Height as cr, type Styles as cs, type Link as ct, type LinkDataOneOf as cu, type Rel as cv, type CodeBlockData as cw, type TextStyle as cx, type DividerData as cy, type FileData as cz, type QueryAvailableTicketDefinitionsOptions as d, type DeleteContext as d$, type Option as d0, type PollSettings as d1, type PollLayout as d2, type OptionLayout as d3, type Gradient as d4, type Background as d5, type BackgroundBackgroundOneOf as d6, type PollDesign as d7, type OptionDesign as d8, type Poll as d9, type ListValue as dA, type AudioData as dB, type OrderedListData as dC, type BulletedListData as dD, type BlockquoteData as dE, type CaptionData as dF, type LayoutCellData as dG, type Metadata as dH, type DocumentStyle as dI, type TextNodeStyle as dJ, type Badge as dK, type EventUpdated as dL, type SeatingPlanCategoriesSummaryUpdated as dM, type CategoryDetails as dN, type DomainEvent as dO, type DomainEventBodyOneOf as dP, type EntityCreatedEvent as dQ, type RestoreInfo as dR, type EntityUpdatedEvent as dS, type EntityDeletedEvent as dT, type ActionEvent as dU, type MetaSiteSpecialEvent as dV, type MetaSiteSpecialEventPayloadOneOf as dW, type Asset as dX, type SiteCreated as dY, type SiteTransferred as dZ, type SiteDeleted as d_, type PollDataLayout as da, type Design as db, type TextData as dc, type Decoration as dd, type DecorationDataOneOf as de, type AnchorData as df, type ColorData as dg, type LinkData as dh, type MentionData as di, type FontSizeData as dj, type SpoilerData as dk, type AppEmbedData as dl, type AppEmbedDataAppDataOneOf as dm, type BookingData as dn, type EventData as dp, type VideoData as dq, type PlaybackOptions as dr, type EmbedData as ds, type Oembed as dt, type CollapsibleListData as du, type TableData as dv, type Dimensions as dw, type TableCellData as dx, type CellStyle as dy, type BorderColors as dz, type QueryAvailableTicketDefinitionsResponse as e, type SiteUndeleted as e0, type SitePublished as e1, type SiteUnpublished as e2, type SiteMarkedAsTemplate as e3, type SiteMarkedAsWixSite as e4, type ServiceProvisioned as e5, type ServiceRemoved as e6, type SiteRenamed as e7, type SiteHardDeleted as e8, type NamespaceChanged as e9, type ReorderTicketDefinitionsOptionsReferenceDefinitionOneOf as eA, type TicketDefinitionsQueryResult as eB, type StudioAssigned as ea, type StudioUnassigned as eb, type GetTicketDefinitionFromTrashBinRequest as ec, type GetTicketDefinitionFromTrashBinResponse as ed, type ScheduleLegacyTimeCapsuleTaskRequest as ee, type MessageEnvelope as ef, type IdentificationData as eg, type IdentificationDataIdOneOf as eh, type GetTicketDefinitionSummaryRequest as ei, type GetTicketDefinitionSummaryResponse as ej, type TicketDefinitionSummary as ek, type ListEventTicketingSummaryRequest as el, type ListEventTicketingSummaryResponse as em, type EventTicketingSummary as en, type ReservationCreated as eo, type TicketQuantity as ep, type ReservationCount as eq, type ReservationUpdated as er, type BaseEventMetadata as es, type EventMetadata as et, type TicketDefinitionCreatedEnvelope as eu, type TicketDefinitionDeletedEnvelope as ev, type TicketDefinitionSaleEndedEnvelope as ew, type TicketDefinitionSalePeriodUpdatedEnvelope as ex, type TicketDefinitionSaleStartedEnvelope as ey, type TicketDefinitionUpdatedEnvelope as ez, type CountTicketDefinitionsOptions as f, type CountTicketDefinitionsResponse as g, type CountAvailableTicketDefinitionsOptions as h, type CountAvailableTicketDefinitionsResponse as i, type ChangeCurrencyOptions as j, SubdivisionSubdivisionType as k, RecurrenceStatusStatus as l, Status as m, Field as n, SortOrder as o, LocationLocationType as p, SubdivisionType as q, EventStatus as r, EventType as s, RegistrationStatus as t, RsvpStatusOptions as u, TaxType as v, ValueType as w, ConferenceType as x, CategoryStateState as y, PluginContainerDataAlignment as z };
|
|
4817
|
+
export {};
|