@wix/events 1.0.302 → 1.0.304

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.
@@ -75,6 +75,10 @@ interface GuestDetails$5 {
75
75
  checkedIn?: boolean;
76
76
  /** The login details for the guest to access the online conference event. */
77
77
  onlineConferencingLogin?: OnlineConferencingLogin$3;
78
+ /** Phone extracted from form response. If multiples phone inputs are present, first one is returned. */
79
+ phone?: string | null;
80
+ /** Address extracted from form response. If multiples address inputs are present, first one is returned. */
81
+ address?: string | null;
78
82
  }
79
83
  interface FormResponse$9 {
80
84
  inputValues?: InputValue$9[];
@@ -336,6 +340,10 @@ interface GuestDetails$4 {
336
340
  checkedIn?: boolean;
337
341
  /** The login details for the guest to access the online conference event. */
338
342
  onlineConferencingLogin?: OnlineConferencingLogin$2;
343
+ /** Phone extracted from form response. If multiples phone inputs are present, first one is returned. */
344
+ phone?: string | null;
345
+ /** Address extracted from form response. If multiples address inputs are present, first one is returned. */
346
+ address?: string | null;
339
347
  }
340
348
  interface FormResponse$8 {
341
349
  inputValues?: InputValue$8[];
@@ -1943,7 +1951,7 @@ interface StaffMember$1 extends StaffMemberEventAccessOneOf$1 {
1943
1951
  /** Scopes. */
1944
1952
  scopes?: Scope$1[];
1945
1953
  /** Status. Remains PENDING until staff member joins. Switches to SUSPENDED if user decides to temporarily revoke staff member access. */
1946
- status?: Status$3;
1954
+ status?: Status$5;
1947
1955
  /**
1948
1956
  * Join link generated for staff member.
1949
1957
  * @readonly
@@ -1972,7 +1980,7 @@ interface SpecificEvents$1 {
1972
1980
  /** Specific events for which staff member have access (can perform check-in). */
1973
1981
  events?: string[];
1974
1982
  }
1975
- declare enum Status$3 {
1983
+ declare enum Status$5 {
1976
1984
  /** Pending. Means that staff member has not joined. */
1977
1985
  PENDING = "PENDING",
1978
1986
  /** Has access. */
@@ -2138,7 +2146,7 @@ interface SpecificEventsNonNullableFields$1 {
2138
2146
  interface StaffMemberNonNullableFields$1 {
2139
2147
  specificEvents?: SpecificEventsNonNullableFields$1;
2140
2148
  scopes: Scope$1[];
2141
- status: Status$3;
2149
+ status: Status$5;
2142
2150
  }
2143
2151
  interface CreateStaffMemberResponseNonNullableFields$1 {
2144
2152
  staffMember?: StaffMemberNonNullableFields$1;
@@ -2192,7 +2200,7 @@ interface StaffMember extends StaffMemberEventAccessOneOf {
2192
2200
  /** Scopes. */
2193
2201
  scopes?: Scope[];
2194
2202
  /** Status. Remains PENDING until staff member joins. Switches to SUSPENDED if user decides to temporarily revoke staff member access. */
2195
- status?: Status$2;
2203
+ status?: Status$4;
2196
2204
  /**
2197
2205
  * Join link generated for staff member.
2198
2206
  * @readonly
@@ -2221,7 +2229,7 @@ interface SpecificEvents {
2221
2229
  /** Specific events for which staff member have access (can perform check-in). */
2222
2230
  events?: string[];
2223
2231
  }
2224
- declare enum Status$2 {
2232
+ declare enum Status$4 {
2225
2233
  /** Pending. Means that staff member has not joined. */
2226
2234
  PENDING = "PENDING",
2227
2235
  /** Has access. */
@@ -2387,7 +2395,7 @@ interface SpecificEventsNonNullableFields {
2387
2395
  interface StaffMemberNonNullableFields {
2388
2396
  specificEvents?: SpecificEventsNonNullableFields;
2389
2397
  scopes: Scope[];
2390
- status: Status$2;
2398
+ status: Status$4;
2391
2399
  }
2392
2400
  interface CreateStaffMemberResponseNonNullableFields {
2393
2401
  staffMember?: StaffMemberNonNullableFields;
@@ -14239,23 +14247,23 @@ interface CancelRsvpGuestsCheckInResponse$1 {
14239
14247
  /** Updated RSVP. */
14240
14248
  rsvp?: V2Rsvp$1;
14241
14249
  }
14242
- interface CommonStreetAddressNonNullableFields$3 {
14250
+ interface CommonStreetAddressNonNullableFields$5 {
14243
14251
  number: string;
14244
14252
  name: string;
14245
14253
  apt: string;
14246
14254
  }
14247
- interface CommonSubdivisionNonNullableFields$1 {
14255
+ interface CommonSubdivisionNonNullableFields$2 {
14248
14256
  code: string;
14249
14257
  name: string;
14250
14258
  type: SubdivisionType;
14251
14259
  }
14252
- interface CommonAddressNonNullableFields$3 {
14253
- streetAddress?: CommonStreetAddressNonNullableFields$3;
14254
- subdivisions: CommonSubdivisionNonNullableFields$1[];
14260
+ interface CommonAddressNonNullableFields$5 {
14261
+ streetAddress?: CommonStreetAddressNonNullableFields$5;
14262
+ subdivisions: CommonSubdivisionNonNullableFields$2[];
14255
14263
  }
14256
14264
  interface FormattedAddressNonNullableFields$1 {
14257
14265
  formatted: string;
14258
- address?: CommonAddressNonNullableFields$3;
14266
+ address?: CommonAddressNonNullableFields$5;
14259
14267
  }
14260
14268
  interface InputValueNonNullableFields$1 {
14261
14269
  inputName: string;
@@ -15198,17 +15206,17 @@ interface CancelRsvpGuestsCheckInResponse {
15198
15206
  /** Updated RSVP. */
15199
15207
  rsvp?: V2Rsvp;
15200
15208
  }
15201
- interface CommonStreetAddressNonNullableFields$2 {
15209
+ interface CommonStreetAddressNonNullableFields$4 {
15202
15210
  number: string;
15203
15211
  name: string;
15204
15212
  apt: string;
15205
15213
  }
15206
- interface CommonAddressNonNullableFields$2 {
15207
- streetAddress?: CommonStreetAddressNonNullableFields$2;
15214
+ interface CommonAddressNonNullableFields$4 {
15215
+ streetAddress?: CommonStreetAddressNonNullableFields$4;
15208
15216
  }
15209
15217
  interface FormattedAddressNonNullableFields {
15210
15218
  formatted: string;
15211
- address?: CommonAddressNonNullableFields$2;
15219
+ address?: CommonAddressNonNullableFields$4;
15212
15220
  }
15213
15221
  interface InputValueNonNullableFields {
15214
15222
  inputName: string;
@@ -15389,9 +15397,9 @@ interface V3Event$1 {
15389
15397
  */
15390
15398
  id?: string;
15391
15399
  /** Event location. */
15392
- location?: Location$1;
15400
+ location?: Location$3;
15393
15401
  /** Event date and time settings. */
15394
- dateAndTimeSettings?: DateAndTimeSettings$1;
15402
+ dateAndTimeSettings?: DateAndTimeSettings$3;
15395
15403
  /** Event title. */
15396
15404
  title?: string | null;
15397
15405
  /**
@@ -15433,7 +15441,7 @@ interface V3Event$1 {
15433
15441
  * - `DRAFT`: Event is not published.
15434
15442
  * @readonly
15435
15443
  */
15436
- status?: Status$1;
15444
+ status?: Status$3;
15437
15445
  /**
15438
15446
  * RSVP or ticketing registration details. <br>
15439
15447
  * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
@@ -15449,7 +15457,7 @@ interface V3Event$1 {
15449
15457
  * Event page URL components. <br>
15450
15458
  * **Note:** This field is returned only when the `URLS` fieldset is included in the request.
15451
15459
  */
15452
- eventPageUrl?: PageUrl;
15460
+ eventPageUrl?: PageUrl$1;
15453
15461
  /**
15454
15462
  * Event registration form. <br>
15455
15463
  * **Note:** This field is returned only when the `FORM` fieldset is included in the request.
@@ -15495,7 +15503,7 @@ interface V3Event$1 {
15495
15503
  /** Visual settings for event. */
15496
15504
  eventDisplaySettings?: V3EventDisplaySettings$1;
15497
15505
  }
15498
- interface Location$1 {
15506
+ interface Location$3 {
15499
15507
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
15500
15508
  name?: string | null;
15501
15509
  /**
@@ -15503,22 +15511,22 @@ interface Location$1 {
15503
15511
  * - `VENUE`: Event is on-site at a specific physical location.
15504
15512
  * - `ONLINE`: Event is online, such as a virtual video conference.
15505
15513
  */
15506
- type?: LocationType$1;
15514
+ type?: LocationType$3;
15507
15515
  /** Exact location address. */
15508
- address?: CommonAddress$1;
15516
+ address?: CommonAddress$3;
15509
15517
  /** Whether the event location is TBD. */
15510
15518
  locationTbd?: boolean | null;
15511
15519
  }
15512
- declare enum LocationType$1 {
15520
+ declare enum LocationType$3 {
15513
15521
  /** Default value. This value is unused. */
15514
15522
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
15515
15523
  VENUE = "VENUE",
15516
15524
  ONLINE = "ONLINE"
15517
15525
  }
15518
15526
  /** Physical address */
15519
- interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {
15527
+ interface CommonAddress$3 extends CommonAddressStreetOneOf$3 {
15520
15528
  /** Street address. */
15521
- streetAddress?: CommonStreetAddress$1;
15529
+ streetAddress?: CommonStreetAddress$3;
15522
15530
  /** Primary address information (street and building number). */
15523
15531
  addressLine?: string | null;
15524
15532
  /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
@@ -15533,19 +15541,19 @@ interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {
15533
15541
  addressLine2?: string | null;
15534
15542
  }
15535
15543
  /** @oneof */
15536
- interface CommonAddressStreetOneOf$1 {
15544
+ interface CommonAddressStreetOneOf$3 {
15537
15545
  /** Street address. */
15538
- streetAddress?: CommonStreetAddress$1;
15546
+ streetAddress?: CommonStreetAddress$3;
15539
15547
  /** Primary address information (street and building number). */
15540
15548
  addressLine?: string | null;
15541
15549
  }
15542
- interface CommonStreetAddress$1 {
15550
+ interface CommonStreetAddress$3 {
15543
15551
  /** Street number. */
15544
15552
  number?: string;
15545
15553
  /** Street name. */
15546
15554
  name?: string;
15547
15555
  }
15548
- declare enum SubdivisionSubdivisionType {
15556
+ declare enum SubdivisionSubdivisionType$1 {
15549
15557
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
15550
15558
  /** State */
15551
15559
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -15560,7 +15568,7 @@ declare enum SubdivisionSubdivisionType {
15560
15568
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
15561
15569
  COUNTRY = "COUNTRY"
15562
15570
  }
15563
- interface DateAndTimeSettings$1 {
15571
+ interface DateAndTimeSettings$3 {
15564
15572
  /** Whether the event date and time are TBD. */
15565
15573
  dateAndTimeTbd?: boolean | null;
15566
15574
  /** Message that is displayed when time and date is TBD. */
@@ -15584,13 +15592,13 @@ interface DateAndTimeSettings$1 {
15584
15592
  * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
15585
15593
  * @readonly
15586
15594
  */
15587
- recurrenceStatus?: RecurrenceStatusStatus$1;
15595
+ recurrenceStatus?: RecurrenceStatusStatus$3;
15588
15596
  /** Event repetitions. */
15589
- recurringEvents?: Recurrences$1;
15597
+ recurringEvents?: Recurrences$3;
15590
15598
  /** Formatted date and time settings. */
15591
- formatted?: Formatted$1;
15599
+ formatted?: Formatted$3;
15592
15600
  }
15593
- declare enum RecurrenceStatusStatus$1 {
15601
+ declare enum RecurrenceStatusStatus$3 {
15594
15602
  /** Default value. This value is unused. */
15595
15603
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
15596
15604
  /** Event happens only once. */
@@ -15604,16 +15612,16 @@ declare enum RecurrenceStatusStatus$1 {
15604
15612
  /** Latest cancelled event from the list of repetitions. */
15605
15613
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
15606
15614
  }
15607
- interface Recurrences$1 {
15615
+ interface Recurrences$3 {
15608
15616
  /** Individual event dates. */
15609
- individualEventDates?: Occurrence$1[];
15617
+ individualEventDates?: Occurrence$3[];
15610
15618
  /**
15611
15619
  * Recurring event category ID.
15612
15620
  * @readonly
15613
15621
  */
15614
15622
  categoryId?: string | null;
15615
15623
  }
15616
- interface Occurrence$1 {
15624
+ interface Occurrence$3 {
15617
15625
  /** Event start date. */
15618
15626
  startDate?: Date;
15619
15627
  /** Event end date. */
@@ -15623,7 +15631,7 @@ interface Occurrence$1 {
15623
15631
  /** Whether the time zone is displayed in a formatted schedule. */
15624
15632
  showTimeZone?: boolean;
15625
15633
  }
15626
- interface Formatted$1 {
15634
+ interface Formatted$3 {
15627
15635
  /**
15628
15636
  * Formatted date and time representation. <br>
15629
15637
  * 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>
@@ -15652,7 +15660,7 @@ interface Formatted$1 {
15652
15660
  */
15653
15661
  endTime?: string | null;
15654
15662
  }
15655
- declare enum Status$1 {
15663
+ declare enum Status$3 {
15656
15664
  /** Default value. This value is unused */
15657
15665
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
15658
15666
  /** Event is public and scheduled to start */
@@ -15666,7 +15674,7 @@ declare enum Status$1 {
15666
15674
  /** Event is not public */
15667
15675
  DRAFT = "DRAFT"
15668
15676
  }
15669
- interface PageUrl {
15677
+ interface PageUrl$1 {
15670
15678
  /** The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). */
15671
15679
  base?: string;
15672
15680
  /** The path to the page. For example, `/product-page/a-product`. */
@@ -16320,7 +16328,7 @@ interface AgendaSettings$1 {
16320
16328
  * Schedule page URL.
16321
16329
  * @readonly
16322
16330
  */
16323
- pageUrl?: PageUrl;
16331
+ pageUrl?: PageUrl$1;
16324
16332
  }
16325
16333
  declare enum Type$3 {
16326
16334
  /** Created manually by the user. */
@@ -16651,33 +16659,33 @@ interface GetEventBySlugResponse$1 {
16651
16659
  /** Event. */
16652
16660
  event?: V3Event$1;
16653
16661
  }
16654
- interface CommonStreetAddressNonNullableFields$1 {
16662
+ interface CommonStreetAddressNonNullableFields$3 {
16655
16663
  number: string;
16656
16664
  name: string;
16657
16665
  apt: string;
16658
16666
  }
16659
- interface CommonSubdivisionNonNullableFields {
16667
+ interface CommonSubdivisionNonNullableFields$1 {
16660
16668
  code: string;
16661
16669
  name: string;
16662
- type: SubdivisionSubdivisionType;
16670
+ type: SubdivisionSubdivisionType$1;
16663
16671
  }
16664
- interface CommonAddressNonNullableFields$1 {
16665
- streetAddress?: CommonStreetAddressNonNullableFields$1;
16666
- subdivisions: CommonSubdivisionNonNullableFields[];
16672
+ interface CommonAddressNonNullableFields$3 {
16673
+ streetAddress?: CommonStreetAddressNonNullableFields$3;
16674
+ subdivisions: CommonSubdivisionNonNullableFields$1[];
16667
16675
  }
16668
- interface LocationNonNullableFields$1 {
16669
- type: LocationType$1;
16670
- address?: CommonAddressNonNullableFields$1;
16676
+ interface LocationNonNullableFields$3 {
16677
+ type: LocationType$3;
16678
+ address?: CommonAddressNonNullableFields$3;
16671
16679
  }
16672
- interface OccurrenceNonNullableFields$1 {
16680
+ interface OccurrenceNonNullableFields$3 {
16673
16681
  showTimeZone: boolean;
16674
16682
  }
16675
- interface RecurrencesNonNullableFields$1 {
16676
- individualEventDates: OccurrenceNonNullableFields$1[];
16683
+ interface RecurrencesNonNullableFields$3 {
16684
+ individualEventDates: OccurrenceNonNullableFields$3[];
16677
16685
  }
16678
- interface DateAndTimeSettingsNonNullableFields$1 {
16679
- recurrenceStatus: RecurrenceStatusStatus$1;
16680
- recurringEvents?: RecurrencesNonNullableFields$1;
16686
+ interface DateAndTimeSettingsNonNullableFields$3 {
16687
+ recurrenceStatus: RecurrenceStatusStatus$3;
16688
+ recurringEvents?: RecurrencesNonNullableFields$3;
16681
16689
  }
16682
16690
  interface CommonImageNonNullableFields {
16683
16691
  id: string;
@@ -16717,7 +16725,7 @@ interface CalendarUrlsNonNullableFields$1 {
16717
16725
  google: string;
16718
16726
  ics: string;
16719
16727
  }
16720
- interface PageUrlNonNullableFields {
16728
+ interface PageUrlNonNullableFields$1 {
16721
16729
  base: string;
16722
16730
  path: string;
16723
16731
  }
@@ -16866,7 +16874,7 @@ interface SeoSettingsNonNullableFields$1 {
16866
16874
  }
16867
16875
  interface AgendaSettingsNonNullableFields$1 {
16868
16876
  enabled: boolean;
16869
- pageUrl?: PageUrlNonNullableFields;
16877
+ pageUrl?: PageUrlNonNullableFields$1;
16870
16878
  }
16871
16879
  interface EventCategoryNonNullableFields$1 {
16872
16880
  id: string;
@@ -16879,14 +16887,14 @@ interface EventCategoriesNonNullableFields$1 {
16879
16887
  }
16880
16888
  interface V3EventNonNullableFields$1 {
16881
16889
  id: string;
16882
- location?: LocationNonNullableFields$1;
16883
- dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields$1;
16890
+ location?: LocationNonNullableFields$3;
16891
+ dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields$3;
16884
16892
  mainImage?: CommonImageNonNullableFields;
16885
16893
  slug: string;
16886
- status: Status$1;
16894
+ status: Status$3;
16887
16895
  registration?: RegistrationNonNullableFields$1;
16888
16896
  calendarUrls?: CalendarUrlsNonNullableFields$1;
16889
- eventPageUrl?: PageUrlNonNullableFields;
16897
+ eventPageUrl?: PageUrlNonNullableFields$1;
16890
16898
  form?: FormNonNullableFields$1;
16891
16899
  summaries?: SummariesNonNullableFields$1;
16892
16900
  instanceId: string;
@@ -16933,9 +16941,9 @@ interface V3Event {
16933
16941
  */
16934
16942
  _id?: string;
16935
16943
  /** Event location. */
16936
- location?: Location;
16944
+ location?: Location$2;
16937
16945
  /** Event date and time settings. */
16938
- dateAndTimeSettings?: DateAndTimeSettings;
16946
+ dateAndTimeSettings?: DateAndTimeSettings$2;
16939
16947
  /** Event title. */
16940
16948
  title?: string | null;
16941
16949
  /** Short description that appears under the event title. */
@@ -16972,7 +16980,7 @@ interface V3Event {
16972
16980
  * - `DRAFT`: Event is not published.
16973
16981
  * @readonly
16974
16982
  */
16975
- status?: Status;
16983
+ status?: Status$2;
16976
16984
  /**
16977
16985
  * RSVP or ticketing registration details. <br>
16978
16986
  * **Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request.
@@ -17034,7 +17042,7 @@ interface V3Event {
17034
17042
  /** Visual settings for event. */
17035
17043
  eventDisplaySettings?: V3EventDisplaySettings;
17036
17044
  }
17037
- interface Location {
17045
+ interface Location$2 {
17038
17046
  /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
17039
17047
  name?: string | null;
17040
17048
  /**
@@ -17043,22 +17051,22 @@ interface Location {
17043
17051
  * - `VENUE`: The event is on-site at a specific physical location.
17044
17052
  * - `ONLINE`: The event is online, such as a virtual video conference.
17045
17053
  */
17046
- type?: LocationType;
17054
+ type?: LocationType$2;
17047
17055
  /** Exact location address. */
17048
- address?: CommonAddress;
17056
+ address?: CommonAddress$2;
17049
17057
  /** Whether the event location is TBD. */
17050
17058
  locationTbd?: boolean | null;
17051
17059
  }
17052
- declare enum LocationType {
17060
+ declare enum LocationType$2 {
17053
17061
  /** Default value. This value is unused. */
17054
17062
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
17055
17063
  VENUE = "VENUE",
17056
17064
  ONLINE = "ONLINE"
17057
17065
  }
17058
17066
  /** Physical address */
17059
- interface CommonAddress extends CommonAddressStreetOneOf {
17067
+ interface CommonAddress$2 extends CommonAddressStreetOneOf$2 {
17060
17068
  /** Street address. */
17061
- streetAddress?: CommonStreetAddress;
17069
+ streetAddress?: CommonStreetAddress$2;
17062
17070
  /** Primary address information (street and building number). */
17063
17071
  addressLine1?: string | null;
17064
17072
  /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
@@ -17073,19 +17081,19 @@ interface CommonAddress extends CommonAddressStreetOneOf {
17073
17081
  addressLine2?: string | null;
17074
17082
  }
17075
17083
  /** @oneof */
17076
- interface CommonAddressStreetOneOf {
17084
+ interface CommonAddressStreetOneOf$2 {
17077
17085
  /** Street address. */
17078
- streetAddress?: CommonStreetAddress;
17086
+ streetAddress?: CommonStreetAddress$2;
17079
17087
  /** Primary address information (street and building number). */
17080
17088
  addressLine?: string | null;
17081
17089
  }
17082
- interface CommonStreetAddress {
17090
+ interface CommonStreetAddress$2 {
17083
17091
  /** Street number. */
17084
17092
  number?: string;
17085
17093
  /** Street name. */
17086
17094
  name?: string;
17087
17095
  }
17088
- interface DateAndTimeSettings {
17096
+ interface DateAndTimeSettings$2 {
17089
17097
  /** Whether the event date and time are TBD. */
17090
17098
  dateAndTimeTbd?: boolean | null;
17091
17099
  /** Message that is displayed when time and date is TBD. */
@@ -17110,13 +17118,13 @@ interface DateAndTimeSettings {
17110
17118
  * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
17111
17119
  * @readonly
17112
17120
  */
17113
- recurrenceStatus?: RecurrenceStatusStatus;
17121
+ recurrenceStatus?: RecurrenceStatusStatus$2;
17114
17122
  /** Event repetitions. */
17115
- recurringEvents?: Recurrences;
17123
+ recurringEvents?: Recurrences$2;
17116
17124
  /** Formatted date and time settings. */
17117
- formatted?: Formatted;
17125
+ formatted?: Formatted$2;
17118
17126
  }
17119
- declare enum RecurrenceStatusStatus {
17127
+ declare enum RecurrenceStatusStatus$2 {
17120
17128
  /** Default value. This value is unused. */
17121
17129
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
17122
17130
  /** Event happens only once. */
@@ -17130,16 +17138,16 @@ declare enum RecurrenceStatusStatus {
17130
17138
  /** Latest cancelled event from the list of repetitions. */
17131
17139
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
17132
17140
  }
17133
- interface Recurrences {
17141
+ interface Recurrences$2 {
17134
17142
  /** Individual event dates info. */
17135
- individualEventDates?: Occurrence[];
17143
+ individualEventDates?: Occurrence$2[];
17136
17144
  /**
17137
17145
  * Recurring event category ID.
17138
17146
  * @readonly
17139
17147
  */
17140
17148
  categoryId?: string | null;
17141
17149
  }
17142
- interface Occurrence {
17150
+ interface Occurrence$2 {
17143
17151
  /** Event start date. */
17144
17152
  startDate?: Date;
17145
17153
  /** Event end date. */
@@ -17149,7 +17157,7 @@ interface Occurrence {
17149
17157
  /** Whether the time zone is displayed in a formatted schedule. */
17150
17158
  showTimeZone?: boolean;
17151
17159
  }
17152
- interface Formatted {
17160
+ interface Formatted$2 {
17153
17161
  /**
17154
17162
  * Formatted date and time representation.
17155
17163
  *
@@ -17179,7 +17187,7 @@ interface Formatted {
17179
17187
  */
17180
17188
  endTime?: string | null;
17181
17189
  }
17182
- declare enum Status {
17190
+ declare enum Status$2 {
17183
17191
  /** Default value. This value is unused */
17184
17192
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
17185
17193
  /** Event is public and scheduled to start */
@@ -18160,27 +18168,27 @@ interface GetEventBySlugResponse {
18160
18168
  /** Event. */
18161
18169
  event?: V3Event;
18162
18170
  }
18163
- interface CommonStreetAddressNonNullableFields {
18171
+ interface CommonStreetAddressNonNullableFields$2 {
18164
18172
  number: string;
18165
18173
  name: string;
18166
18174
  apt: string;
18167
18175
  }
18168
- interface CommonAddressNonNullableFields {
18169
- streetAddress?: CommonStreetAddressNonNullableFields;
18176
+ interface CommonAddressNonNullableFields$2 {
18177
+ streetAddress?: CommonStreetAddressNonNullableFields$2;
18170
18178
  }
18171
- interface LocationNonNullableFields {
18172
- type: LocationType;
18173
- address?: CommonAddressNonNullableFields;
18179
+ interface LocationNonNullableFields$2 {
18180
+ type: LocationType$2;
18181
+ address?: CommonAddressNonNullableFields$2;
18174
18182
  }
18175
- interface OccurrenceNonNullableFields {
18183
+ interface OccurrenceNonNullableFields$2 {
18176
18184
  showTimeZone: boolean;
18177
18185
  }
18178
- interface RecurrencesNonNullableFields {
18179
- individualEventDates: OccurrenceNonNullableFields[];
18186
+ interface RecurrencesNonNullableFields$2 {
18187
+ individualEventDates: OccurrenceNonNullableFields$2[];
18180
18188
  }
18181
- interface DateAndTimeSettingsNonNullableFields {
18182
- recurrenceStatus: RecurrenceStatusStatus;
18183
- recurringEvents?: RecurrencesNonNullableFields;
18189
+ interface DateAndTimeSettingsNonNullableFields$2 {
18190
+ recurrenceStatus: RecurrenceStatusStatus$2;
18191
+ recurringEvents?: RecurrencesNonNullableFields$2;
18184
18192
  }
18185
18193
  interface RsvpRegistrationNonNullableFields {
18186
18194
  responseType: ResponseType;
@@ -18372,11 +18380,11 @@ interface EventCategoriesNonNullableFields {
18372
18380
  }
18373
18381
  interface V3EventNonNullableFields {
18374
18382
  _id: string;
18375
- location?: LocationNonNullableFields;
18376
- dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields;
18383
+ location?: LocationNonNullableFields$2;
18384
+ dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields$2;
18377
18385
  mainImage: string;
18378
18386
  slug: string;
18379
- status: Status;
18387
+ status: Status$2;
18380
18388
  registration?: RegistrationNonNullableFields;
18381
18389
  calendarUrls?: CalendarUrlsNonNullableFields;
18382
18390
  eventPageUrl: string;
@@ -18546,6 +18554,11 @@ interface TicketDefinition$1 {
18546
18554
  limitPerCheckout?: number | null;
18547
18555
  /** Data extensions. */
18548
18556
  extendedFields?: ExtendedFields$1;
18557
+ /**
18558
+ * Associated event information. <br>
18559
+ * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.
18560
+ */
18561
+ eventDetails?: EventDetails$1;
18549
18562
  }
18550
18563
  interface SalePeriod$1 {
18551
18564
  /** Ticket sale start timestamp. */
@@ -18662,102 +18675,313 @@ interface ExtendedFields$1 {
18662
18675
  */
18663
18676
  namespaces?: Record<string, Record<string, any>>;
18664
18677
  }
18665
- interface CreateTicketDefinitionRequest$1 {
18666
- /** Ticket definition info. */
18667
- ticketDefinition: TicketDefinition$1;
18678
+ interface EventDetails$1 {
18668
18679
  /**
18669
- * Predefined sets of fields to return.
18670
- * - `SALES_DETAILS`: Returns `salesDetails`.
18680
+ * Event title.
18681
+ * @readonly
18671
18682
  */
18672
- fields?: Field$1[];
18673
- }
18674
- declare enum Field$1 {
18675
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
18676
- /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
18677
- SALES_DETAILS = "SALES_DETAILS"
18678
- }
18679
- interface CreateTicketDefinitionResponse$1 {
18680
- /** Created ticket definition. */
18681
- ticketDefinition?: TicketDefinition$1;
18682
- }
18683
- interface UpdateTicketDefinitionRequest$1 {
18684
- /** Ticket definition to update. */
18685
- ticketDefinition: TicketDefinition$1;
18683
+ title?: string | null;
18686
18684
  /**
18687
- * Predefined sets of fields to return.
18688
- * - `SALES_DETAILS`: Returns `salesDetails`.
18685
+ * Event short description.
18686
+ * @readonly
18689
18687
  */
18690
- fields?: Field$1[];
18691
- }
18692
- interface UpdateTicketDefinitionResponse$1 {
18693
- /** The updated ticket definition. */
18694
- ticketDefinition?: TicketDefinition$1;
18695
- }
18696
- interface GetTicketDefinitionRequest$1 {
18697
- /** Ticket definition ID. */
18698
- ticketDefinitionId: string;
18688
+ shortDescription?: string | null;
18699
18689
  /**
18700
- * Predefined sets of fields to return.
18701
- * - `SALES_DETAILS`: Returns `salesDetails`.
18690
+ * Event location.
18691
+ * @readonly
18702
18692
  */
18703
- fields?: Field$1[];
18704
- }
18705
- interface GetTicketDefinitionResponse$1 {
18706
- /** The requested ticket definition. */
18707
- ticketDefinition?: TicketDefinition$1;
18708
- }
18709
- interface DeleteTicketDefinitionRequest$1 {
18710
- /** ID of the ticket definition to delete. */
18711
- ticketDefinitionId: string;
18712
- }
18713
- interface DeleteTicketDefinitionResponse$1 {
18714
- }
18715
- interface ReorderTicketDefinitionsRequest$1 extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf$1 {
18716
- /** Move the given `definitionId` before the referenced ticket definition. */
18717
- beforeDefinitionId?: string;
18718
- /** Move the given `definitionId` after the referenced ticket definition. */
18719
- afterDefinitionId?: string;
18720
- /** Event ID. */
18721
- eventId: string;
18722
- /** Ticket definition ID. */
18723
- ticketDefinitionId: string;
18724
- }
18725
- /** @oneof */
18726
- interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf$1 {
18727
- /** Move the given `definitionId` before the referenced ticket definition. */
18728
- beforeDefinitionId?: string;
18729
- /** Move the given `definitionId` after the referenced ticket definition. */
18730
- afterDefinitionId?: string;
18731
- }
18732
- interface ReorderTicketDefinitionsResponse$1 {
18693
+ location?: Location$1;
18694
+ /**
18695
+ * Event date and time settings.
18696
+ * @readonly
18697
+ */
18698
+ dateAndTimeSettings?: DateAndTimeSettings$1;
18699
+ /**
18700
+ * Event page URL components.
18701
+ * @readonly
18702
+ */
18703
+ eventPageUrl?: PageUrl;
18704
+ /**
18705
+ * Event status.
18706
+ * @readonly
18707
+ */
18708
+ status?: Status$1;
18733
18709
  }
18734
- interface QueryTicketDefinitionsRequest$1 {
18735
- /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
18736
- query: QueryV2$1;
18710
+ interface Location$1 {
18711
+ /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
18712
+ name?: string | null;
18737
18713
  /**
18738
- * Predefined sets of fields to return.
18739
- * - `SALES_DETAILS`: Returns `salesDetails`.
18714
+ * Location type. Possible values:
18715
+ * - `VENUE`: Event is on-site at a specific physical location.
18716
+ * - `ONLINE`: Event is online, such as a virtual video conference.
18740
18717
  */
18741
- fields?: Field$1[];
18718
+ type?: LocationType$1;
18719
+ /** Exact location address. */
18720
+ address?: CommonAddress$1;
18721
+ /** Whether the event location is TBD. */
18722
+ locationTbd?: boolean | null;
18742
18723
  }
18743
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
18744
- /** Paging options to limit and skip the number of items. */
18745
- paging?: Paging$1;
18746
- /** 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. */
18747
- cursorPaging?: CursorPaging$1;
18748
- /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "id": "2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5", "revision": {"$ne":"1"} }` */
18749
- filter?: Record<string, any> | null;
18750
- /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */
18751
- sort?: Sorting$1[];
18724
+ declare enum LocationType$1 {
18725
+ /** Default value. This value is unused. */
18726
+ UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
18727
+ VENUE = "VENUE",
18728
+ ONLINE = "ONLINE"
18729
+ }
18730
+ /** Physical address */
18731
+ interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {
18732
+ /** Street address. */
18733
+ streetAddress?: CommonStreetAddress$1;
18734
+ /** Primary address information (street and building number). */
18735
+ addressLine?: string | null;
18736
+ /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
18737
+ country?: string | null;
18738
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
18739
+ subdivision?: string | null;
18740
+ /** City name. */
18741
+ city?: string | null;
18742
+ /** Zip or postal code. */
18743
+ postalCode?: string | null;
18744
+ /** Secondary address information (suite or apartment number and room number). */
18745
+ addressLine2?: string | null;
18752
18746
  }
18753
18747
  /** @oneof */
18754
- interface QueryV2PagingMethodOneOf$1 {
18755
- /** Paging options to limit and skip the number of items. */
18756
- paging?: Paging$1;
18757
- /** 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. */
18758
- cursorPaging?: CursorPaging$1;
18748
+ interface CommonAddressStreetOneOf$1 {
18749
+ /** Street address. */
18750
+ streetAddress?: CommonStreetAddress$1;
18751
+ /** Primary address information (street and building number). */
18752
+ addressLine?: string | null;
18759
18753
  }
18760
- interface Sorting$1 {
18754
+ interface CommonStreetAddress$1 {
18755
+ /** Street number. */
18756
+ number?: string;
18757
+ /** Street name. */
18758
+ name?: string;
18759
+ }
18760
+ declare enum SubdivisionSubdivisionType {
18761
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
18762
+ /** State */
18763
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
18764
+ /** County */
18765
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
18766
+ /** City/town */
18767
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
18768
+ /** Neighborhood/quarter */
18769
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
18770
+ /** Street/block */
18771
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
18772
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
18773
+ COUNTRY = "COUNTRY"
18774
+ }
18775
+ interface DateAndTimeSettings$1 {
18776
+ /** Whether the event date and time are TBD. */
18777
+ dateAndTimeTbd?: boolean | null;
18778
+ /** Message that is displayed when time and date is TBD. */
18779
+ dateAndTimeTbdMessage?: string | null;
18780
+ /** Event start date. */
18781
+ startDate?: Date;
18782
+ /** Event end date. */
18783
+ endDate?: Date;
18784
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
18785
+ timeZoneId?: string | null;
18786
+ /** Whether the end date is hidden in the formatted date and time. */
18787
+ hideEndDate?: boolean | null;
18788
+ /** Whether the time zone is displayed in the formatted schedule. */
18789
+ showTimeZone?: boolean | null;
18790
+ /**
18791
+ * Repeating event status. Possible values:
18792
+ * - `ONE_TIME`: Event happens only once and can last multiple days.
18793
+ * - `RECURRING`: A series of events that repeat.
18794
+ * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
18795
+ * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
18796
+ * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
18797
+ * @readonly
18798
+ */
18799
+ recurrenceStatus?: RecurrenceStatusStatus$1;
18800
+ /** Event repetitions. */
18801
+ recurringEvents?: Recurrences$1;
18802
+ /** Formatted date and time settings. */
18803
+ formatted?: Formatted$1;
18804
+ }
18805
+ declare enum RecurrenceStatusStatus$1 {
18806
+ /** Default value. This value is unused. */
18807
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
18808
+ /** Event happens only once. */
18809
+ ONE_TIME = "ONE_TIME",
18810
+ /** Event is repeating and has a list of scheduled repetitions. */
18811
+ RECURRING = "RECURRING",
18812
+ /** An upcoming event from the list of repetitions. */
18813
+ RECURRING_UPCOMING = "RECURRING_UPCOMING",
18814
+ /** Latest ended event from the list of repetitions. */
18815
+ RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
18816
+ /** Latest cancelled event from the list of repetitions. */
18817
+ RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
18818
+ }
18819
+ interface Recurrences$1 {
18820
+ /** Individual event dates. */
18821
+ individualEventDates?: Occurrence$1[];
18822
+ /**
18823
+ * Recurring event category ID.
18824
+ * @readonly
18825
+ */
18826
+ categoryId?: string | null;
18827
+ }
18828
+ interface Occurrence$1 {
18829
+ /** Event start date. */
18830
+ startDate?: Date;
18831
+ /** Event end date. */
18832
+ endDate?: Date;
18833
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
18834
+ timeZoneId?: string | null;
18835
+ /** Whether the time zone is displayed in a formatted schedule. */
18836
+ showTimeZone?: boolean;
18837
+ }
18838
+ interface Formatted$1 {
18839
+ /**
18840
+ * Formatted date and time representation. <br>
18841
+ * 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>
18842
+ * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
18843
+ * @readonly
18844
+ */
18845
+ dateAndTime?: string | null;
18846
+ /**
18847
+ * Formatted start date of the event. Empty for TBD schedules.
18848
+ * @readonly
18849
+ */
18850
+ startDate?: string | null;
18851
+ /**
18852
+ * Formatted start time of the event. Empty for TBD schedules.
18853
+ * @readonly
18854
+ */
18855
+ startTime?: string | null;
18856
+ /**
18857
+ * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
18858
+ * @readonly
18859
+ */
18860
+ endDate?: string | null;
18861
+ /**
18862
+ * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
18863
+ * @readonly
18864
+ */
18865
+ endTime?: string | null;
18866
+ }
18867
+ interface PageUrl {
18868
+ /** The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). */
18869
+ base?: string;
18870
+ /** The path to the page. For example, `/product-page/a-product`. */
18871
+ path?: string;
18872
+ }
18873
+ declare enum Status$1 {
18874
+ /** Default value. This value is unused */
18875
+ UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
18876
+ /** Event is public and scheduled to start */
18877
+ UPCOMING = "UPCOMING",
18878
+ /** Event has started */
18879
+ STARTED = "STARTED",
18880
+ /** Event has ended */
18881
+ ENDED = "ENDED",
18882
+ /** Event is canceled */
18883
+ CANCELED = "CANCELED",
18884
+ /** Event is not public */
18885
+ DRAFT = "DRAFT"
18886
+ }
18887
+ interface CreateTicketDefinitionRequest$1 {
18888
+ /** Ticket definition info. */
18889
+ ticketDefinition: TicketDefinition$1;
18890
+ /**
18891
+ * Predefined sets of fields to return.
18892
+ * - `SALES_DETAILS`: Returns `salesDetails`.
18893
+ */
18894
+ fields?: Field$1[];
18895
+ }
18896
+ declare enum Field$1 {
18897
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
18898
+ /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
18899
+ SALES_DETAILS = "SALES_DETAILS",
18900
+ /** Include `eventDetails`. */
18901
+ EVENT_DETAILS = "EVENT_DETAILS"
18902
+ }
18903
+ interface CreateTicketDefinitionResponse$1 {
18904
+ /** Created ticket definition. */
18905
+ ticketDefinition?: TicketDefinition$1;
18906
+ }
18907
+ interface UpdateTicketDefinitionRequest$1 {
18908
+ /** Ticket definition to update. */
18909
+ ticketDefinition: TicketDefinition$1;
18910
+ /**
18911
+ * Predefined sets of fields to return.
18912
+ * - `SALES_DETAILS`: Returns `salesDetails`.
18913
+ */
18914
+ fields?: Field$1[];
18915
+ }
18916
+ interface UpdateTicketDefinitionResponse$1 {
18917
+ /** The updated ticket definition. */
18918
+ ticketDefinition?: TicketDefinition$1;
18919
+ }
18920
+ interface GetTicketDefinitionRequest$1 {
18921
+ /** Ticket definition ID. */
18922
+ ticketDefinitionId: string;
18923
+ /**
18924
+ * Predefined sets of fields to return.
18925
+ * - `SALES_DETAILS`: Returns `salesDetails`.
18926
+ */
18927
+ fields?: Field$1[];
18928
+ }
18929
+ interface GetTicketDefinitionResponse$1 {
18930
+ /** The requested ticket definition. */
18931
+ ticketDefinition?: TicketDefinition$1;
18932
+ }
18933
+ interface DeleteTicketDefinitionRequest$1 {
18934
+ /** ID of the ticket definition to delete. */
18935
+ ticketDefinitionId: string;
18936
+ }
18937
+ interface DeleteTicketDefinitionResponse$1 {
18938
+ }
18939
+ interface ReorderTicketDefinitionsRequest$1 extends ReorderTicketDefinitionsRequestReferenceDefinitionOneOf$1 {
18940
+ /** Move the given `definitionId` before the referenced ticket definition. */
18941
+ beforeDefinitionId?: string;
18942
+ /** Move the given `definitionId` after the referenced ticket definition. */
18943
+ afterDefinitionId?: string;
18944
+ /** Event ID. */
18945
+ eventId: string;
18946
+ /** Ticket definition ID. */
18947
+ ticketDefinitionId: string;
18948
+ }
18949
+ /** @oneof */
18950
+ interface ReorderTicketDefinitionsRequestReferenceDefinitionOneOf$1 {
18951
+ /** Move the given `definitionId` before the referenced ticket definition. */
18952
+ beforeDefinitionId?: string;
18953
+ /** Move the given `definitionId` after the referenced ticket definition. */
18954
+ afterDefinitionId?: string;
18955
+ }
18956
+ interface ReorderTicketDefinitionsResponse$1 {
18957
+ }
18958
+ interface QueryTicketDefinitionsRequest$1 {
18959
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
18960
+ query: QueryV2$1;
18961
+ /**
18962
+ * Predefined sets of fields to return.
18963
+ * - `SALES_DETAILS`: Returns `salesDetails`.
18964
+ */
18965
+ fields?: Field$1[];
18966
+ }
18967
+ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
18968
+ /** Paging options to limit and skip the number of items. */
18969
+ paging?: Paging$1;
18970
+ /** 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. */
18971
+ cursorPaging?: CursorPaging$1;
18972
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "id": "2224a9d1-79e6-4549-a5c5-bf7ce5aac1a5", "revision": {"$ne":"1"} }` */
18973
+ filter?: Record<string, any> | null;
18974
+ /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/policy-v2/filter-and-sort) for more information. */
18975
+ sort?: Sorting$1[];
18976
+ }
18977
+ /** @oneof */
18978
+ interface QueryV2PagingMethodOneOf$1 {
18979
+ /** Paging options to limit and skip the number of items. */
18980
+ paging?: Paging$1;
18981
+ /** 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. */
18982
+ cursorPaging?: CursorPaging$1;
18983
+ }
18984
+ interface Sorting$1 {
18761
18985
  /** Name of the field to sort by. */
18762
18986
  fieldName?: string;
18763
18987
  /** Defaults to `ASC` */
@@ -18885,6 +19109,44 @@ interface PricingMethodNonNullableFields$1 {
18885
19109
  interface SalePeriodNonNullableFields$1 {
18886
19110
  displayNotOnSale: boolean;
18887
19111
  }
19112
+ interface CommonStreetAddressNonNullableFields$1 {
19113
+ number: string;
19114
+ name: string;
19115
+ apt: string;
19116
+ }
19117
+ interface CommonSubdivisionNonNullableFields {
19118
+ code: string;
19119
+ name: string;
19120
+ type: SubdivisionSubdivisionType;
19121
+ }
19122
+ interface CommonAddressNonNullableFields$1 {
19123
+ streetAddress?: CommonStreetAddressNonNullableFields$1;
19124
+ subdivisions: CommonSubdivisionNonNullableFields[];
19125
+ }
19126
+ interface LocationNonNullableFields$1 {
19127
+ type: LocationType$1;
19128
+ address?: CommonAddressNonNullableFields$1;
19129
+ }
19130
+ interface OccurrenceNonNullableFields$1 {
19131
+ showTimeZone: boolean;
19132
+ }
19133
+ interface RecurrencesNonNullableFields$1 {
19134
+ individualEventDates: OccurrenceNonNullableFields$1[];
19135
+ }
19136
+ interface DateAndTimeSettingsNonNullableFields$1 {
19137
+ recurrenceStatus: RecurrenceStatusStatus$1;
19138
+ recurringEvents?: RecurrencesNonNullableFields$1;
19139
+ }
19140
+ interface PageUrlNonNullableFields {
19141
+ base: string;
19142
+ path: string;
19143
+ }
19144
+ interface EventDetailsNonNullableFields$1 {
19145
+ location?: LocationNonNullableFields$1;
19146
+ dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields$1;
19147
+ eventPageUrl?: PageUrlNonNullableFields;
19148
+ status: Status$1;
19149
+ }
18888
19150
  interface TicketDefinitionNonNullableFields$1 {
18889
19151
  hidden: boolean;
18890
19152
  limited: boolean;
@@ -18893,6 +19155,7 @@ interface TicketDefinitionNonNullableFields$1 {
18893
19155
  salePeriod?: SalePeriodNonNullableFields$1;
18894
19156
  saleStatus: SaleStatusEnumStatus$1;
18895
19157
  sortIndex: number;
19158
+ eventDetails?: EventDetailsNonNullableFields$1;
18896
19159
  }
18897
19160
  interface CreateTicketDefinitionResponseNonNullableFields$1 {
18898
19161
  ticketDefinition?: TicketDefinitionNonNullableFields$1;
@@ -18984,6 +19247,11 @@ interface TicketDefinition {
18984
19247
  limitPerCheckout?: number | null;
18985
19248
  /** Data extensions. */
18986
19249
  extendedFields?: ExtendedFields;
19250
+ /**
19251
+ * Associated event information. <br>
19252
+ * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.
19253
+ */
19254
+ eventDetails?: EventDetails;
18987
19255
  }
18988
19256
  interface SalePeriod {
18989
19257
  /** Ticket sale start timestamp. */
@@ -19100,6 +19368,194 @@ interface ExtendedFields {
19100
19368
  */
19101
19369
  namespaces?: Record<string, Record<string, any>>;
19102
19370
  }
19371
+ interface EventDetails {
19372
+ /**
19373
+ * Event title.
19374
+ * @readonly
19375
+ */
19376
+ title?: string | null;
19377
+ /**
19378
+ * Event short description.
19379
+ * @readonly
19380
+ */
19381
+ shortDescription?: string | null;
19382
+ /**
19383
+ * Event location.
19384
+ * @readonly
19385
+ */
19386
+ location?: Location;
19387
+ /**
19388
+ * Event date and time settings.
19389
+ * @readonly
19390
+ */
19391
+ dateAndTimeSettings?: DateAndTimeSettings;
19392
+ /**
19393
+ * Event page URL components.
19394
+ * @readonly
19395
+ */
19396
+ eventPageUrl?: string;
19397
+ /**
19398
+ * Event status.
19399
+ * @readonly
19400
+ */
19401
+ status?: Status;
19402
+ }
19403
+ interface Location {
19404
+ /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
19405
+ name?: string | null;
19406
+ /**
19407
+ * Location type. Possible values:
19408
+ * - `VENUE`: Event is on-site at a specific physical location.
19409
+ * - `ONLINE`: Event is online, such as a virtual video conference.
19410
+ */
19411
+ type?: LocationType;
19412
+ /** Exact location address. */
19413
+ address?: CommonAddress;
19414
+ /** Whether the event location is TBD. */
19415
+ locationTbd?: boolean | null;
19416
+ }
19417
+ declare enum LocationType {
19418
+ /** Default value. This value is unused. */
19419
+ UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
19420
+ VENUE = "VENUE",
19421
+ ONLINE = "ONLINE"
19422
+ }
19423
+ /** Physical address */
19424
+ interface CommonAddress extends CommonAddressStreetOneOf {
19425
+ /** Street address. */
19426
+ streetAddress?: CommonStreetAddress;
19427
+ /** Primary address information (street and building number). */
19428
+ addressLine1?: string | null;
19429
+ /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
19430
+ country?: string | null;
19431
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
19432
+ subdivision?: string | null;
19433
+ /** City name. */
19434
+ city?: string | null;
19435
+ /** Zip or postal code. */
19436
+ postalCode?: string | null;
19437
+ /** Secondary address information (suite or apartment number and room number). */
19438
+ addressLine2?: string | null;
19439
+ }
19440
+ /** @oneof */
19441
+ interface CommonAddressStreetOneOf {
19442
+ /** Street address. */
19443
+ streetAddress?: CommonStreetAddress;
19444
+ /** Primary address information (street and building number). */
19445
+ addressLine?: string | null;
19446
+ }
19447
+ interface CommonStreetAddress {
19448
+ /** Street number. */
19449
+ number?: string;
19450
+ /** Street name. */
19451
+ name?: string;
19452
+ }
19453
+ interface DateAndTimeSettings {
19454
+ /** Whether the event date and time are TBD. */
19455
+ dateAndTimeTbd?: boolean | null;
19456
+ /** Message that is displayed when time and date is TBD. */
19457
+ dateAndTimeTbdMessage?: string | null;
19458
+ /** Event start date. */
19459
+ startDate?: Date;
19460
+ /** Event end date. */
19461
+ endDate?: Date;
19462
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
19463
+ timeZoneId?: string | null;
19464
+ /** Whether the end date is hidden in the formatted date and time. */
19465
+ hideEndDate?: boolean | null;
19466
+ /** Whether the time zone is displayed in the formatted schedule. */
19467
+ showTimeZone?: boolean | null;
19468
+ /**
19469
+ * Repeating event status. Possible values:
19470
+ * - `ONE_TIME`: Event happens only once and can last multiple days.
19471
+ * - `RECURRING`: A series of events that repeat.
19472
+ * - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
19473
+ * - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
19474
+ * - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events..
19475
+ * @readonly
19476
+ */
19477
+ recurrenceStatus?: RecurrenceStatusStatus;
19478
+ /** Event repetitions. */
19479
+ recurringEvents?: Recurrences;
19480
+ /** Formatted date and time settings. */
19481
+ formatted?: Formatted;
19482
+ }
19483
+ declare enum RecurrenceStatusStatus {
19484
+ /** Default value. This value is unused. */
19485
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
19486
+ /** Event happens only once. */
19487
+ ONE_TIME = "ONE_TIME",
19488
+ /** Event is repeating and has a list of scheduled repetitions. */
19489
+ RECURRING = "RECURRING",
19490
+ /** An upcoming event from the list of repetitions. */
19491
+ RECURRING_UPCOMING = "RECURRING_UPCOMING",
19492
+ /** Latest ended event from the list of repetitions. */
19493
+ RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
19494
+ /** Latest cancelled event from the list of repetitions. */
19495
+ RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
19496
+ }
19497
+ interface Recurrences {
19498
+ /** Individual event dates. */
19499
+ individualEventDates?: Occurrence[];
19500
+ /**
19501
+ * Recurring event category ID.
19502
+ * @readonly
19503
+ */
19504
+ categoryId?: string | null;
19505
+ }
19506
+ interface Occurrence {
19507
+ /** Event start date. */
19508
+ startDate?: Date;
19509
+ /** Event end date. */
19510
+ endDate?: Date;
19511
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
19512
+ timeZoneId?: string | null;
19513
+ /** Whether the time zone is displayed in a formatted schedule. */
19514
+ showTimeZone?: boolean;
19515
+ }
19516
+ interface Formatted {
19517
+ /**
19518
+ * Formatted date and time representation. <br>
19519
+ * 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>
19520
+ * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
19521
+ * @readonly
19522
+ */
19523
+ dateAndTime?: string | null;
19524
+ /**
19525
+ * Formatted start date of the event. Empty for TBD schedules.
19526
+ * @readonly
19527
+ */
19528
+ startDate?: string | null;
19529
+ /**
19530
+ * Formatted start time of the event. Empty for TBD schedules.
19531
+ * @readonly
19532
+ */
19533
+ startTime?: string | null;
19534
+ /**
19535
+ * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
19536
+ * @readonly
19537
+ */
19538
+ endDate?: string | null;
19539
+ /**
19540
+ * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
19541
+ * @readonly
19542
+ */
19543
+ endTime?: string | null;
19544
+ }
19545
+ declare enum Status {
19546
+ /** Default value. This value is unused */
19547
+ UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
19548
+ /** Event is public and scheduled to start */
19549
+ UPCOMING = "UPCOMING",
19550
+ /** Event has started */
19551
+ STARTED = "STARTED",
19552
+ /** Event has ended */
19553
+ ENDED = "ENDED",
19554
+ /** Event is canceled */
19555
+ CANCELED = "CANCELED",
19556
+ /** Event is not public */
19557
+ DRAFT = "DRAFT"
19558
+ }
19103
19559
  interface CreateTicketDefinitionRequest {
19104
19560
  /** Ticket definition info. */
19105
19561
  ticketDefinition: TicketDefinition;
@@ -19112,7 +19568,9 @@ interface CreateTicketDefinitionRequest {
19112
19568
  declare enum Field {
19113
19569
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
19114
19570
  /** Include `unsoldCount`, `soldCount`, `reservedCount` and `soldOut` in the response. */
19115
- SALES_DETAILS = "SALES_DETAILS"
19571
+ SALES_DETAILS = "SALES_DETAILS",
19572
+ /** Include `eventDetails`. */
19573
+ EVENT_DETAILS = "EVENT_DETAILS"
19116
19574
  }
19117
19575
  interface CreateTicketDefinitionResponse {
19118
19576
  /** Created ticket definition. */
@@ -19323,6 +19781,34 @@ interface PricingMethodNonNullableFields {
19323
19781
  interface SalePeriodNonNullableFields {
19324
19782
  displayNotOnSale: boolean;
19325
19783
  }
19784
+ interface CommonStreetAddressNonNullableFields {
19785
+ number: string;
19786
+ name: string;
19787
+ apt: string;
19788
+ }
19789
+ interface CommonAddressNonNullableFields {
19790
+ streetAddress?: CommonStreetAddressNonNullableFields;
19791
+ }
19792
+ interface LocationNonNullableFields {
19793
+ type: LocationType;
19794
+ address?: CommonAddressNonNullableFields;
19795
+ }
19796
+ interface OccurrenceNonNullableFields {
19797
+ showTimeZone: boolean;
19798
+ }
19799
+ interface RecurrencesNonNullableFields {
19800
+ individualEventDates: OccurrenceNonNullableFields[];
19801
+ }
19802
+ interface DateAndTimeSettingsNonNullableFields {
19803
+ recurrenceStatus: RecurrenceStatusStatus;
19804
+ recurringEvents?: RecurrencesNonNullableFields;
19805
+ }
19806
+ interface EventDetailsNonNullableFields {
19807
+ location?: LocationNonNullableFields;
19808
+ dateAndTimeSettings?: DateAndTimeSettingsNonNullableFields;
19809
+ eventPageUrl: string;
19810
+ status: Status;
19811
+ }
19326
19812
  interface TicketDefinitionNonNullableFields {
19327
19813
  hidden: boolean;
19328
19814
  limited: boolean;
@@ -19331,6 +19817,7 @@ interface TicketDefinitionNonNullableFields {
19331
19817
  salePeriod?: SalePeriodNonNullableFields;
19332
19818
  saleStatus: SaleStatusEnumStatus;
19333
19819
  sortIndex: number;
19820
+ eventDetails?: EventDetailsNonNullableFields;
19334
19821
  }
19335
19822
  interface CreateTicketDefinitionResponseNonNullableFields {
19336
19823
  ticketDefinition?: TicketDefinitionNonNullableFields;