@wix/events 1.0.346 → 1.0.348

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.
@@ -1858,10 +1858,6 @@ interface GuestCreatedEnvelope {
1858
1858
  entity: EventGuest;
1859
1859
  metadata: EventMetadata$6;
1860
1860
  }
1861
- interface GuestUpdatedEnvelope {
1862
- entity: EventGuest;
1863
- metadata: EventMetadata$6;
1864
- }
1865
1861
  interface GuestDeletedEnvelope {
1866
1862
  entity: EventGuest;
1867
1863
  metadata: EventMetadata$6;
@@ -1882,6 +1878,10 @@ interface GuestOrderCanceledEnvelope {
1882
1878
  data: GuestOrderCanceled;
1883
1879
  metadata: EventMetadata$6;
1884
1880
  }
1881
+ interface GuestUpdatedEnvelope {
1882
+ entity: EventGuest;
1883
+ metadata: EventMetadata$6;
1884
+ }
1885
1885
  interface QueryEventGuestsOptions {
1886
1886
  /** Predefined sets of fields to return. */
1887
1887
  fields?: RequestedFieldsEnumRequestedFields[] | undefined;
@@ -1962,12 +1962,12 @@ interface QueryGuestsSignature {
1962
1962
  (options?: QueryEventGuestsOptions | undefined): GuestsQueryBuilder;
1963
1963
  }
1964
1964
  declare const onGuestCreated$1: EventDefinition<GuestCreatedEnvelope, "wix.events.guests.v1.guest_created">;
1965
- declare const onGuestUpdated$1: EventDefinition<GuestUpdatedEnvelope, "wix.events.guests.v1.guest_updated">;
1966
1965
  declare const onGuestDeleted$1: EventDefinition<GuestDeletedEnvelope, "wix.events.guests.v1.guest_deleted">;
1967
1966
  declare const onGuestCheckedIn$1: EventDefinition<GuestCheckedInEnvelope, "wix.events.guests.v1.guest_guest_checked_in">;
1968
1967
  declare const onGuestEventCanceled$1: EventDefinition<GuestEventCanceledEnvelope, "wix.events.guests.v1.guest_guest_event_canceled">;
1969
1968
  declare const onGuestEventStarts$1: EventDefinition<GuestEventStartsEnvelope, "wix.events.guests.v1.guest_guest_event_starts">;
1970
1969
  declare const onGuestOrderCanceled$1: EventDefinition<GuestOrderCanceledEnvelope, "wix.events.guests.v1.guest_guest_order_canceled">;
1970
+ declare const onGuestUpdated$1: EventDefinition<GuestUpdatedEnvelope, "wix.events.guests.v1.guest_updated">;
1971
1971
 
1972
1972
  declare function createEventModule$b<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1973
1973
 
@@ -1979,12 +1979,6 @@ type _publicOnGuestCreatedType = typeof onGuestCreated$1;
1979
1979
  */
1980
1980
  declare const onGuestCreated: ReturnType<typeof createEventModule$b<_publicOnGuestCreatedType>>;
1981
1981
 
1982
- type _publicOnGuestUpdatedType = typeof onGuestUpdated$1;
1983
- /**
1984
- * Triggered when a guest is updated. This webhook always fires together with [Event Guest Created](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-created) and [Event Guest Deleted](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-deleted) webhooks. When calling it, it might be triggered twice - make sure to explicitly add code to make sure parts of your code only run once.
1985
- */
1986
- declare const onGuestUpdated: ReturnType<typeof createEventModule$b<_publicOnGuestUpdatedType>>;
1987
-
1988
1982
  type _publicOnGuestDeletedType = typeof onGuestDeleted$1;
1989
1983
  /**
1990
1984
  * Triggered when a guest is deleted.
@@ -2009,6 +2003,12 @@ type _publicOnGuestOrderCanceledType = typeof onGuestOrderCanceled$1;
2009
2003
  /** */
2010
2004
  declare const onGuestOrderCanceled: ReturnType<typeof createEventModule$b<_publicOnGuestOrderCanceledType>>;
2011
2005
 
2006
+ type _publicOnGuestUpdatedType = typeof onGuestUpdated$1;
2007
+ /**
2008
+ * Triggered when a guest is updated. This webhook always fires together with [Event Guest Created](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-created) and [Event Guest Deleted](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-deleted) webhooks. When calling it, it might be triggered twice - make sure to explicitly add code to make sure parts of your code only run once.
2009
+ */
2010
+ declare const onGuestUpdated: ReturnType<typeof createEventModule$b<_publicOnGuestUpdatedType>>;
2011
+
2012
2012
  type context$f_AttendanceStatus = AttendanceStatus;
2013
2013
  declare const context$f_AttendanceStatus: typeof AttendanceStatus;
2014
2014
  type context$f_ContactEventStatusUpdated = ContactEventStatusUpdated;
@@ -5637,11 +5637,11 @@ interface StaffMemberCreatedEnvelope {
5637
5637
  entity: StaffMember;
5638
5638
  metadata: EventMetadata$4;
5639
5639
  }
5640
- interface StaffMemberUpdatedEnvelope {
5641
- entity: StaffMember;
5640
+ interface StaffMemberDeletedEnvelope {
5642
5641
  metadata: EventMetadata$4;
5643
5642
  }
5644
- interface StaffMemberDeletedEnvelope {
5643
+ interface StaffMemberUpdatedEnvelope {
5644
+ entity: StaffMember;
5645
5645
  metadata: EventMetadata$4;
5646
5646
  }
5647
5647
  interface GetStaffMemberOptions {
@@ -5835,8 +5835,8 @@ interface AccessStaffMemberSignature {
5835
5835
  (accessToken: string): Promise<AccessStaffMemberResponse & AccessStaffMemberResponseNonNullableFields>;
5836
5836
  }
5837
5837
  declare const onStaffMemberCreated$1: EventDefinition<StaffMemberCreatedEnvelope, "wix.events.staffmembers.v1.staff_member_created">;
5838
- declare const onStaffMemberUpdated$1: EventDefinition<StaffMemberUpdatedEnvelope, "wix.events.staffmembers.v1.staff_member_updated">;
5839
5838
  declare const onStaffMemberDeleted$1: EventDefinition<StaffMemberDeletedEnvelope, "wix.events.staffmembers.v1.staff_member_deleted">;
5839
+ declare const onStaffMemberUpdated$1: EventDefinition<StaffMemberUpdatedEnvelope, "wix.events.staffmembers.v1.staff_member_updated">;
5840
5840
 
5841
5841
  declare function createEventModule$9<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
5842
5842
 
@@ -5853,14 +5853,14 @@ type _publicOnStaffMemberCreatedType = typeof onStaffMemberCreated$1;
5853
5853
  /** */
5854
5854
  declare const onStaffMemberCreated: ReturnType<typeof createEventModule$9<_publicOnStaffMemberCreatedType>>;
5855
5855
 
5856
- type _publicOnStaffMemberUpdatedType = typeof onStaffMemberUpdated$1;
5857
- /** */
5858
- declare const onStaffMemberUpdated: ReturnType<typeof createEventModule$9<_publicOnStaffMemberUpdatedType>>;
5859
-
5860
5856
  type _publicOnStaffMemberDeletedType = typeof onStaffMemberDeleted$1;
5861
5857
  /** */
5862
5858
  declare const onStaffMemberDeleted: ReturnType<typeof createEventModule$9<_publicOnStaffMemberDeletedType>>;
5863
5859
 
5860
+ type _publicOnStaffMemberUpdatedType = typeof onStaffMemberUpdated$1;
5861
+ /** */
5862
+ declare const onStaffMemberUpdated: ReturnType<typeof createEventModule$9<_publicOnStaffMemberUpdatedType>>;
5863
+
5864
5864
  type context$b_AccessStaffMemberRequest = AccessStaffMemberRequest;
5865
5865
  type context$b_AccessStaffMemberResponse = AccessStaffMemberResponse;
5866
5866
  type context$b_AccessStaffMemberResponseNonNullableFields = AccessStaffMemberResponseNonNullableFields;
@@ -12909,38 +12909,6 @@ interface RichContentQueryResult extends QueryCursorResult$4 {
12909
12909
  prev: () => Promise<RichContentQueryResult>;
12910
12910
  }
12911
12911
  interface RichContentQueryBuilder {
12912
- /** @param propertyName - Property whose value is compared with `value`.
12913
- * @param value - Value to compare against.
12914
- * @documentationMaturity preview
12915
- */
12916
- eq: (propertyName: '_id' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;
12917
- /** @param propertyName - Property whose value is compared with `value`.
12918
- * @param value - Value to compare against.
12919
- * @documentationMaturity preview
12920
- */
12921
- ne: (propertyName: '_id' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;
12922
- /** @param propertyName - Property whose value is compared with `string`.
12923
- * @param string - String to compare against. Case-insensitive.
12924
- * @documentationMaturity preview
12925
- */
12926
- startsWith: (propertyName: '_id' | 'eventId' | 'fieldName', value: string) => RichContentQueryBuilder;
12927
- /** @param propertyName - Property whose value is compared with `values`.
12928
- * @param values - List of values to compare against.
12929
- * @documentationMaturity preview
12930
- */
12931
- hasSome: (propertyName: '_id' | 'eventId' | 'fieldName', value: any[]) => RichContentQueryBuilder;
12932
- /** @documentationMaturity preview */
12933
- in: (propertyName: '_id' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;
12934
- /** @documentationMaturity preview */
12935
- exists: (propertyName: '_id' | 'eventId' | 'fieldName', value: boolean) => RichContentQueryBuilder;
12936
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
12937
- * @documentationMaturity preview
12938
- */
12939
- ascending: (...propertyNames: Array<'_id' | 'eventId' | 'fieldName'>) => RichContentQueryBuilder;
12940
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
12941
- * @documentationMaturity preview
12942
- */
12943
- descending: (...propertyNames: Array<'_id' | 'eventId' | 'fieldName'>) => RichContentQueryBuilder;
12944
12912
  /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
12945
12913
  * @documentationMaturity preview
12946
12914
  */
@@ -13008,15 +12976,20 @@ interface QueryRichContentsSignature {
13008
12976
  declare function queryRichContent$1(httpClient: HttpClient): QueryRichContentSignature;
13009
12977
  interface QueryRichContentSignature {
13010
12978
  /**
13011
- * Retrieves a list of rich content entities, given the provided paging, filtering, and sorting.
12979
+ * Creates a query to retrieve a list of rich content entities.
13012
12980
  *
13013
- * Query Rich Content runs with these defaults, which you can override:
13014
- * - `createdDate` is sorted in `ASC` order
13015
- * - `paging.limit` is `100`
13016
- * - `paging.offset` is `0`
12981
+ * The `queryRichContent()` function builds a query to retrieve a list of events and returns a `RichContentQueryBuilder` object.
12982
+ *
12983
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
12984
+ *
12985
+ * You can refine the query by chaining `RichContentQueryBuilder` functions onto the query. `RichContentQueryBuilder` functions enable you to sort, filter, and control the results `queryRichContent()` returns.
12986
+ *
12987
+ * `queryRichContent()` runs with these `RichContentQueryBuilder` defaults, which you can override:
13017
12988
  *
13018
- * For field support for filters and sorting, see [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/filter-and-sort).
13019
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
12989
+ * - `skip(0)`
12990
+ * - `limit(50)`
12991
+ * - `descending("_createdDate")`
12992
+ * The functions that are chained to `queryRichContent()` are applied in the order they're called. For example, if you apply ascending('eventId') and then descending('id'), the results are sorted first by the event ID, and then, if there are multiple results with the same event ID, the items are sorted by ID.
13020
12993
  */
13021
12994
  (): RichContentQueryBuilder;
13022
12995
  }
@@ -13916,14 +13889,14 @@ interface RsvpCreatedEnvelope {
13916
13889
  data: RsvpCreated;
13917
13890
  metadata: BaseEventMetadata$5;
13918
13891
  }
13919
- interface RsvpUpdatedEnvelope {
13920
- data: RsvpUpdated;
13921
- metadata: BaseEventMetadata$5;
13922
- }
13923
13892
  interface RsvpDeletedEnvelope {
13924
13893
  data: RsvpDeleted;
13925
13894
  metadata: BaseEventMetadata$5;
13926
13895
  }
13896
+ interface RsvpUpdatedEnvelope {
13897
+ data: RsvpUpdated;
13898
+ metadata: BaseEventMetadata$5;
13899
+ }
13927
13900
  interface ListRsvpOptions {
13928
13901
  /** Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
13929
13902
  offset?: number;
@@ -14159,8 +14132,8 @@ interface DeleteRsvpCheckInSignature {
14159
14132
  (eventId: string, options?: DeleteRsvpCheckInOptions | undefined): Promise<DeleteRsvpCheckInResponse & DeleteRsvpCheckInResponseNonNullableFields>;
14160
14133
  }
14161
14134
  declare const onRsvpCreated$1: EventDefinition<RsvpCreatedEnvelope, "wix.events.rsvp.events.RsvpCreated">;
14162
- declare const onRsvpUpdated$1: EventDefinition<RsvpUpdatedEnvelope, "wix.events.rsvp.events.RsvpUpdated">;
14163
14135
  declare const onRsvpDeleted$1: EventDefinition<RsvpDeletedEnvelope, "wix.events.rsvp.events.RsvpDeleted">;
14136
+ declare const onRsvpUpdated$1: EventDefinition<RsvpUpdatedEnvelope, "wix.events.rsvp.events.RsvpUpdated">;
14164
14137
 
14165
14138
  declare function createEventModule$5<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
14166
14139
 
@@ -14178,14 +14151,14 @@ type _publicOnRsvpCreatedType = typeof onRsvpCreated$1;
14178
14151
  /** */
14179
14152
  declare const onRsvpCreated: ReturnType<typeof createEventModule$5<_publicOnRsvpCreatedType>>;
14180
14153
 
14181
- type _publicOnRsvpUpdatedType = typeof onRsvpUpdated$1;
14182
- /** */
14183
- declare const onRsvpUpdated: ReturnType<typeof createEventModule$5<_publicOnRsvpUpdatedType>>;
14184
-
14185
14154
  type _publicOnRsvpDeletedType = typeof onRsvpDeleted$1;
14186
14155
  /** */
14187
14156
  declare const onRsvpDeleted: ReturnType<typeof createEventModule$5<_publicOnRsvpDeletedType>>;
14188
14157
 
14158
+ type _publicOnRsvpUpdatedType = typeof onRsvpUpdated$1;
14159
+ /** */
14160
+ declare const onRsvpUpdated: ReturnType<typeof createEventModule$5<_publicOnRsvpUpdatedType>>;
14161
+
14189
14162
  type context$6_CheckInRsvpOptions = CheckInRsvpOptions;
14190
14163
  type context$6_CheckInRsvpRequest = CheckInRsvpRequest;
14191
14164
  type context$6_CheckInRsvpResponse = CheckInRsvpResponse;
@@ -15747,14 +15720,14 @@ interface TicketDefinitionCreatedEnvelope$1 {
15747
15720
  data: TicketDefinitionCreated;
15748
15721
  metadata: BaseEventMetadata$3;
15749
15722
  }
15750
- interface TicketDefinitionUpdatedEnvelope$1 {
15751
- data: TicketDefinitionUpdated;
15752
- metadata: BaseEventMetadata$3;
15753
- }
15754
15723
  interface TicketDefinitionDeletedEnvelope$1 {
15755
15724
  data: TicketDefinitionDeleted;
15756
15725
  metadata: BaseEventMetadata$3;
15757
15726
  }
15727
+ interface TicketDefinitionUpdatedEnvelope$1 {
15728
+ data: TicketDefinitionUpdated;
15729
+ metadata: BaseEventMetadata$3;
15730
+ }
15758
15731
  interface QueryTicketDefinitionsOptions$1 {
15759
15732
  /** Offset. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
15760
15733
  offset?: number;
@@ -16032,8 +16005,8 @@ interface ChangeCurrencySignature$1 {
16032
16005
  (options?: ChangeCurrencyOptions$1 | undefined): Promise<void>;
16033
16006
  }
16034
16007
  declare const onTicketDefinitionCreated$3: EventDefinition<TicketDefinitionCreatedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionCreated">;
16035
- declare const onTicketDefinitionUpdated$3: EventDefinition<TicketDefinitionUpdatedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionUpdated">;
16036
16008
  declare const onTicketDefinitionDeleted$3: EventDefinition<TicketDefinitionDeletedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionDeleted">;
16009
+ declare const onTicketDefinitionUpdated$3: EventDefinition<TicketDefinitionUpdatedEnvelope$1, "wix.events.ticketing.events.TicketDefinitionUpdated">;
16037
16010
 
16038
16011
  declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
16039
16012
 
@@ -16050,14 +16023,14 @@ type _publicOnTicketDefinitionCreatedType$1 = typeof onTicketDefinitionCreated$3
16050
16023
  /** */
16051
16024
  declare const onTicketDefinitionCreated$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionCreatedType>>;
16052
16025
 
16053
- type _publicOnTicketDefinitionUpdatedType$1 = typeof onTicketDefinitionUpdated$3;
16054
- /** */
16055
- declare const onTicketDefinitionUpdated$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionUpdatedType>>;
16056
-
16057
16026
  type _publicOnTicketDefinitionDeletedType$1 = typeof onTicketDefinitionDeleted$3;
16058
16027
  /** */
16059
16028
  declare const onTicketDefinitionDeleted$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionDeletedType>>;
16060
16029
 
16030
+ type _publicOnTicketDefinitionUpdatedType$1 = typeof onTicketDefinitionUpdated$3;
16031
+ /** */
16032
+ declare const onTicketDefinitionUpdated$2: ReturnType<typeof createEventModule$3<_publicOnTicketDefinitionUpdatedType>>;
16033
+
16061
16034
  type context$4_ById = ById;
16062
16035
  type context$4_DefinitionsQueryBuilder = DefinitionsQueryBuilder;
16063
16036
  type context$4_DefinitionsQueryResult = DefinitionsQueryResult;
@@ -16658,11 +16631,11 @@ interface PolicyCreatedEnvelope {
16658
16631
  entity: Policy;
16659
16632
  metadata: EventMetadata$2;
16660
16633
  }
16661
- interface PolicyUpdatedEnvelope {
16662
- entity: Policy;
16634
+ interface PolicyDeletedEnvelope {
16663
16635
  metadata: EventMetadata$2;
16664
16636
  }
16665
- interface PolicyDeletedEnvelope {
16637
+ interface PolicyUpdatedEnvelope {
16638
+ entity: Policy;
16666
16639
  metadata: EventMetadata$2;
16667
16640
  }
16668
16641
  interface UpdatePolicy {
@@ -16873,8 +16846,8 @@ interface GetPolicySignature {
16873
16846
  (policyId: string): Promise<Policy & PolicyNonNullableFields>;
16874
16847
  }
16875
16848
  declare const onPolicyCreated$1: EventDefinition<PolicyCreatedEnvelope, "wix.events.v2.policy_created">;
16876
- declare const onPolicyUpdated$1: EventDefinition<PolicyUpdatedEnvelope, "wix.events.v2.policy_updated">;
16877
16849
  declare const onPolicyDeleted$1: EventDefinition<PolicyDeletedEnvelope, "wix.events.v2.policy_deleted">;
16850
+ declare const onPolicyUpdated$1: EventDefinition<PolicyUpdatedEnvelope, "wix.events.v2.policy_updated">;
16878
16851
 
16879
16852
  declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
16880
16853
 
@@ -16891,18 +16864,18 @@ type _publicOnPolicyCreatedType = typeof onPolicyCreated$1;
16891
16864
  */
16892
16865
  declare const onPolicyCreated: ReturnType<typeof createEventModule$2<_publicOnPolicyCreatedType>>;
16893
16866
 
16894
- type _publicOnPolicyUpdatedType = typeof onPolicyUpdated$1;
16895
- /**
16896
- * Triggered when a policy is updated.
16897
- */
16898
- declare const onPolicyUpdated: ReturnType<typeof createEventModule$2<_publicOnPolicyUpdatedType>>;
16899
-
16900
16867
  type _publicOnPolicyDeletedType = typeof onPolicyDeleted$1;
16901
16868
  /**
16902
16869
  * Triggered when a policy is deleted.
16903
16870
  */
16904
16871
  declare const onPolicyDeleted: ReturnType<typeof createEventModule$2<_publicOnPolicyDeletedType>>;
16905
16872
 
16873
+ type _publicOnPolicyUpdatedType = typeof onPolicyUpdated$1;
16874
+ /**
16875
+ * Triggered when a policy is updated.
16876
+ */
16877
+ declare const onPolicyUpdated: ReturnType<typeof createEventModule$2<_publicOnPolicyUpdatedType>>;
16878
+
16906
16879
  type context$3_CreatePolicyRequest = CreatePolicyRequest;
16907
16880
  type context$3_CreatePolicyResponse = CreatePolicyResponse;
16908
16881
  type context$3_CreatePolicyResponseNonNullableFields = CreatePolicyResponseNonNullableFields;
@@ -22198,39 +22171,39 @@ interface EventMetadata$1 extends BaseEventMetadata$1 {
22198
22171
  */
22199
22172
  entityEventSequence?: string | null;
22200
22173
  }
22201
- interface EventCreatedEnvelope {
22202
- entity: V3Event;
22174
+ interface EventCanceledEnvelope {
22175
+ data: EventEventCanceled;
22203
22176
  metadata: EventMetadata$1;
22204
22177
  }
22205
- interface EventUpdatedEnvelope {
22206
- entity: V3Event;
22178
+ interface EventClonedEnvelope {
22179
+ data: EventCloned;
22207
22180
  metadata: EventMetadata$1;
22208
22181
  }
22209
- interface EventDeletedEnvelope {
22182
+ interface EventCreatedEnvelope {
22183
+ entity: V3Event;
22210
22184
  metadata: EventMetadata$1;
22211
22185
  }
22212
- interface EventStartedEnvelope {
22213
- data: EventEventStarted;
22186
+ interface EventDeletedEnvelope {
22214
22187
  metadata: EventMetadata$1;
22215
22188
  }
22216
22189
  interface EventEndedEnvelope {
22217
22190
  data: EventEventEnded;
22218
22191
  metadata: EventMetadata$1;
22219
22192
  }
22220
- interface EventReminderEnvelope {
22221
- data: EventEventReminder;
22222
- metadata: EventMetadata$1;
22223
- }
22224
22193
  interface EventPublishedEnvelope {
22225
22194
  data: EventEventPublished;
22226
22195
  metadata: EventMetadata$1;
22227
22196
  }
22228
- interface EventClonedEnvelope {
22229
- data: EventCloned;
22197
+ interface EventReminderEnvelope {
22198
+ data: EventEventReminder;
22230
22199
  metadata: EventMetadata$1;
22231
22200
  }
22232
- interface EventCanceledEnvelope {
22233
- data: EventEventCanceled;
22201
+ interface EventStartedEnvelope {
22202
+ data: EventEventStarted;
22203
+ metadata: EventMetadata$1;
22204
+ }
22205
+ interface EventUpdatedEnvelope {
22206
+ entity: V3Event;
22234
22207
  metadata: EventMetadata$1;
22235
22208
  }
22236
22209
  interface CreateEventOptions {
@@ -22586,6 +22559,8 @@ declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
22586
22559
  interface GetEventSignature {
22587
22560
  /**
22588
22561
  * Retrieves an event by ID.
22562
+ *
22563
+ * To retrieve an event description, call [Get Rich Content](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/get-rich-content).
22589
22564
  * @param - Event ID.
22590
22565
  * @param - Optional fields.
22591
22566
  * @returns Event.
@@ -22604,15 +22579,15 @@ interface GetEventBySlugSignature {
22604
22579
  */
22605
22580
  (slug: string | null, options?: GetEventBySlugOptions | undefined): Promise<GetEventBySlugResponse & GetEventBySlugResponseNonNullableFields>;
22606
22581
  }
22582
+ declare const onEventCanceled$1: EventDefinition<EventCanceledEnvelope, "wix.events.v3.event_canceled">;
22583
+ declare const onEventCloned$1: EventDefinition<EventClonedEnvelope, "wix.events.v3.event_cloned">;
22607
22584
  declare const onEventCreated$1: EventDefinition<EventCreatedEnvelope, "wix.events.v3.event_created">;
22608
- declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.events.v3.event_updated">;
22609
22585
  declare const onEventDeleted$1: EventDefinition<EventDeletedEnvelope, "wix.events.v3.event_deleted">;
22610
- declare const onEventStarted$1: EventDefinition<EventStartedEnvelope, "wix.events.v3.event_started">;
22611
22586
  declare const onEventEnded$1: EventDefinition<EventEndedEnvelope, "wix.events.v3.event_ended">;
22612
- declare const onEventReminder$1: EventDefinition<EventReminderEnvelope, "wix.events.v3.event_reminder">;
22613
22587
  declare const onEventPublished$1: EventDefinition<EventPublishedEnvelope, "wix.events.v3.event_published">;
22614
- declare const onEventCloned$1: EventDefinition<EventClonedEnvelope, "wix.events.v3.event_cloned">;
22615
- declare const onEventCanceled$1: EventDefinition<EventCanceledEnvelope, "wix.events.v3.event_canceled">;
22588
+ declare const onEventReminder$1: EventDefinition<EventReminderEnvelope, "wix.events.v3.event_reminder">;
22589
+ declare const onEventStarted$1: EventDefinition<EventStartedEnvelope, "wix.events.v3.event_started">;
22590
+ declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.events.v3.event_updated">;
22616
22591
 
22617
22592
  declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
22618
22593
 
@@ -22629,29 +22604,29 @@ declare const countEventsByStatus: MaybeContext<BuildRESTFunction<typeof countEv
22629
22604
  declare const getEvent: MaybeContext<BuildRESTFunction<typeof getEvent$1> & typeof getEvent$1>;
22630
22605
  declare const getEventBySlug: MaybeContext<BuildRESTFunction<typeof getEventBySlug$1> & typeof getEventBySlug$1>;
22631
22606
 
22632
- type _publicOnEventCreatedType = typeof onEventCreated$1;
22607
+ type _publicOnEventCanceledType = typeof onEventCanceled$1;
22633
22608
  /**
22634
- * Triggered when event is created.
22609
+ * Triggered when event is canceled.
22635
22610
  */
22636
- declare const onEventCreated: ReturnType<typeof createEventModule$1<_publicOnEventCreatedType>>;
22611
+ declare const onEventCanceled: ReturnType<typeof createEventModule$1<_publicOnEventCanceledType>>;
22637
22612
 
22638
- type _publicOnEventUpdatedType = typeof onEventUpdated$1;
22613
+ type _publicOnEventClonedType = typeof onEventCloned$1;
22639
22614
  /**
22640
- * Triggered when event is updated.
22615
+ * Triggered when event is cloned.
22641
22616
  */
22642
- declare const onEventUpdated: ReturnType<typeof createEventModule$1<_publicOnEventUpdatedType>>;
22617
+ declare const onEventCloned: ReturnType<typeof createEventModule$1<_publicOnEventClonedType>>;
22643
22618
 
22644
- type _publicOnEventDeletedType = typeof onEventDeleted$1;
22619
+ type _publicOnEventCreatedType = typeof onEventCreated$1;
22645
22620
  /**
22646
- * Triggered when event is deleted.
22621
+ * Triggered when event is created.
22647
22622
  */
22648
- declare const onEventDeleted: ReturnType<typeof createEventModule$1<_publicOnEventDeletedType>>;
22623
+ declare const onEventCreated: ReturnType<typeof createEventModule$1<_publicOnEventCreatedType>>;
22649
22624
 
22650
- type _publicOnEventStartedType = typeof onEventStarted$1;
22625
+ type _publicOnEventDeletedType = typeof onEventDeleted$1;
22651
22626
  /**
22652
- * Triggered when event has started.
22627
+ * Triggered when event is deleted.
22653
22628
  */
22654
- declare const onEventStarted: ReturnType<typeof createEventModule$1<_publicOnEventStartedType>>;
22629
+ declare const onEventDeleted: ReturnType<typeof createEventModule$1<_publicOnEventDeletedType>>;
22655
22630
 
22656
22631
  type _publicOnEventEndedType = typeof onEventEnded$1;
22657
22632
  /**
@@ -22659,6 +22634,12 @@ type _publicOnEventEndedType = typeof onEventEnded$1;
22659
22634
  */
22660
22635
  declare const onEventEnded: ReturnType<typeof createEventModule$1<_publicOnEventEndedType>>;
22661
22636
 
22637
+ type _publicOnEventPublishedType = typeof onEventPublished$1;
22638
+ /**
22639
+ * Triggered when event is published.
22640
+ */
22641
+ declare const onEventPublished: ReturnType<typeof createEventModule$1<_publicOnEventPublishedType>>;
22642
+
22662
22643
  type _publicOnEventReminderType = typeof onEventReminder$1;
22663
22644
  /**
22664
22645
  * Triggered when a certain amount of time is left until the event. In total there are 6 reminders:
@@ -22671,23 +22652,17 @@ type _publicOnEventReminderType = typeof onEventReminder$1;
22671
22652
  */
22672
22653
  declare const onEventReminder: ReturnType<typeof createEventModule$1<_publicOnEventReminderType>>;
22673
22654
 
22674
- type _publicOnEventPublishedType = typeof onEventPublished$1;
22675
- /**
22676
- * Triggered when event is published.
22677
- */
22678
- declare const onEventPublished: ReturnType<typeof createEventModule$1<_publicOnEventPublishedType>>;
22679
-
22680
- type _publicOnEventClonedType = typeof onEventCloned$1;
22655
+ type _publicOnEventStartedType = typeof onEventStarted$1;
22681
22656
  /**
22682
- * Triggered when event is cloned.
22657
+ * Triggered when event has started.
22683
22658
  */
22684
- declare const onEventCloned: ReturnType<typeof createEventModule$1<_publicOnEventClonedType>>;
22659
+ declare const onEventStarted: ReturnType<typeof createEventModule$1<_publicOnEventStartedType>>;
22685
22660
 
22686
- type _publicOnEventCanceledType = typeof onEventCanceled$1;
22661
+ type _publicOnEventUpdatedType = typeof onEventUpdated$1;
22687
22662
  /**
22688
- * Triggered when event is canceled.
22663
+ * Triggered when event is updated.
22689
22664
  */
22690
- declare const onEventCanceled: ReturnType<typeof createEventModule$1<_publicOnEventCanceledType>>;
22665
+ declare const onEventUpdated: ReturnType<typeof createEventModule$1<_publicOnEventUpdatedType>>;
22691
22666
 
22692
22667
  type context$1_AgendaSettings = AgendaSettings;
22693
22668
  type context$1_BulkCancelEventsByFilterOptions = BulkCancelEventsByFilterOptions;
@@ -23246,161 +23221,39 @@ declare enum Status {
23246
23221
  /** Event is not public. */
23247
23222
  DRAFT = "DRAFT"
23248
23223
  }
23249
- interface SalePeriodUpdated {
23250
- /** Ticket definition sale period after update. */
23251
- afterUpdate?: SalePeriod;
23252
- }
23253
- interface TicketDefinitionSaleStarted {
23254
- /** Ticket definition. */
23255
- ticketDefinition?: TicketDefinition;
23224
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
23225
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
23226
+ metaSiteId?: string;
23227
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
23228
+ siteId?: string;
23229
+ /** Invalidate by App */
23230
+ app?: App;
23231
+ /** Invalidate by page id */
23232
+ page?: Page;
23233
+ /** Invalidate by URI path */
23234
+ uri?: URI;
23235
+ /** Invalidate by file (for media files such as PDFs) */
23236
+ file?: File;
23237
+ /** tell us why you're invalidating the cache. You don't need to add your app name */
23238
+ reason?: string | null;
23239
+ /** Is local DS */
23240
+ localDc?: boolean;
23241
+ hardPurge?: boolean;
23256
23242
  }
23257
- interface TicketDefinitionSaleEnded {
23258
- /** Ticket definition. */
23259
- ticketDefinition?: TicketDefinition;
23260
- }
23261
- interface DomainEvent extends DomainEventBodyOneOf {
23262
- createdEvent?: EntityCreatedEvent;
23263
- updatedEvent?: EntityUpdatedEvent;
23264
- deletedEvent?: EntityDeletedEvent;
23265
- actionEvent?: ActionEvent;
23266
- /**
23267
- * Unique event ID.
23268
- * Allows clients to ignore duplicate webhooks.
23269
- */
23270
- _id?: string;
23271
- /**
23272
- * Assumes actions are also always typed to an entity_type
23273
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
23274
- */
23275
- entityFqdn?: string;
23276
- /**
23277
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
23278
- * This is although the created/updated/deleted notion is duplication of the oneof types
23279
- * Example: created/updated/deleted/started/completed/email_opened
23280
- */
23281
- slug?: string;
23282
- /** ID of the entity associated with the event. */
23283
- entityId?: string;
23284
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
23285
- eventTime?: Date | null;
23286
- /**
23287
- * Whether the event was triggered as a result of a privacy regulation application
23288
- * (for example, GDPR).
23289
- */
23290
- triggeredByAnonymizeRequest?: boolean | null;
23291
- /** If present, indicates the action that triggered the event. */
23292
- originatedFrom?: string | null;
23293
- /**
23294
- * A sequence number defining the order of updates to the underlying entity.
23295
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
23296
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
23297
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
23298
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
23299
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
23300
- */
23301
- entityEventSequence?: string | null;
23302
- }
23303
- /** @oneof */
23304
- interface DomainEventBodyOneOf {
23305
- createdEvent?: EntityCreatedEvent;
23306
- updatedEvent?: EntityUpdatedEvent;
23307
- deletedEvent?: EntityDeletedEvent;
23308
- actionEvent?: ActionEvent;
23309
- }
23310
- interface EntityCreatedEvent {
23311
- entity?: string;
23312
- }
23313
- interface RestoreInfo {
23314
- deletedDate?: Date | null;
23315
- }
23316
- interface EntityUpdatedEvent {
23317
- /**
23318
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
23319
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
23320
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
23321
- */
23322
- currentEntity?: string;
23323
- }
23324
- interface EntityDeletedEvent {
23325
- /** Entity that was deleted */
23326
- deletedEntity?: string | null;
23327
- }
23328
- interface ActionEvent {
23329
- body?: string;
23330
- }
23331
- interface MessageEnvelope {
23332
- /** App instance ID. */
23333
- instanceId?: string | null;
23334
- /** Event type. */
23335
- eventType?: string;
23336
- /** The identification type and identity data. */
23337
- identity?: IdentificationData;
23338
- /** Stringify payload. */
23339
- data?: string;
23340
- }
23341
- interface IdentificationData extends IdentificationDataIdOneOf {
23342
- /** ID of a site visitor that has not logged in to the site. */
23343
- anonymousVisitorId?: string;
23344
- /** ID of a site visitor that has logged in to the site. */
23345
- memberId?: string;
23346
- /** ID of a Wix user (site owner, contributor, etc.). */
23347
- wixUserId?: string;
23348
- /** ID of an app. */
23349
- appId?: string;
23350
- /** @readonly */
23351
- identityType?: WebhookIdentityType;
23352
- }
23353
- /** @oneof */
23354
- interface IdentificationDataIdOneOf {
23355
- /** ID of a site visitor that has not logged in to the site. */
23356
- anonymousVisitorId?: string;
23357
- /** ID of a site visitor that has logged in to the site. */
23358
- memberId?: string;
23359
- /** ID of a Wix user (site owner, contributor, etc.). */
23360
- wixUserId?: string;
23361
- /** ID of an app. */
23362
- appId?: string;
23363
- }
23364
- declare enum WebhookIdentityType {
23365
- UNKNOWN = "UNKNOWN",
23366
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
23367
- MEMBER = "MEMBER",
23368
- WIX_USER = "WIX_USER",
23369
- APP = "APP"
23370
- }
23371
- interface InvalidateCache extends InvalidateCacheGetByOneOf {
23372
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
23373
- metaSiteId?: string;
23374
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
23375
- siteId?: string;
23376
- /** Invalidate by App */
23377
- app?: App;
23378
- /** Invalidate by page id */
23379
- page?: Page;
23380
- /** Invalidate by URI path */
23381
- uri?: URI;
23382
- /** Invalidate by file (for media files such as PDFs) */
23383
- file?: File;
23384
- /** tell us why you're invalidating the cache. You don't need to add your app name */
23385
- reason?: string | null;
23386
- /** Is local DS */
23387
- localDc?: boolean;
23388
- hardPurge?: boolean;
23389
- }
23390
- /** @oneof */
23391
- interface InvalidateCacheGetByOneOf {
23392
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
23393
- metaSiteId?: string;
23394
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
23395
- siteId?: string;
23396
- /** Invalidate by App */
23397
- app?: App;
23398
- /** Invalidate by page id */
23399
- page?: Page;
23400
- /** Invalidate by URI path */
23401
- uri?: URI;
23402
- /** Invalidate by file (for media files such as PDFs) */
23403
- file?: File;
23243
+ /** @oneof */
23244
+ interface InvalidateCacheGetByOneOf {
23245
+ /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
23246
+ metaSiteId?: string;
23247
+ /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
23248
+ siteId?: string;
23249
+ /** Invalidate by App */
23250
+ app?: App;
23251
+ /** Invalidate by page id */
23252
+ page?: Page;
23253
+ /** Invalidate by URI path */
23254
+ uri?: URI;
23255
+ /** Invalidate by file (for media files such as PDFs) */
23256
+ file?: File;
23404
23257
  }
23405
23258
  interface App {
23406
23259
  /** The AppDefId */
@@ -23426,181 +23279,17 @@ interface File {
23426
23279
  /** Invalidate by filename (for media files such as PDFs) */
23427
23280
  fileName?: string;
23428
23281
  }
23429
- interface GetTicketDefinitionSummaryRequest {
23430
- /** Ticket definition id. */
23431
- ticketDefinitionId?: string | null;
23432
- }
23433
- interface GetTicketDefinitionSummaryResponse {
23434
- /** Summary. */
23435
- summary?: TicketDefinitionSummary;
23436
- }
23437
- interface TicketDefinitionSummary {
23438
- /**
23439
- * Ticket definition ID.
23440
- * @readonly
23441
- */
23442
- definitionId?: string | null;
23443
- /**
23444
- * Event ID to which the ticket definition summary belongs.
23445
- * @readonly
23446
- */
23447
- eventId?: string | null;
23448
- /**
23449
- * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
23450
- * @readonly
23451
- */
23452
- _updatedDate?: Date | null;
23453
- /**
23454
- * Reserved count.
23455
- * @readonly
23456
- */
23457
- reservedCount?: number;
23458
- /**
23459
- * Sold count.
23460
- * @readonly
23461
- */
23462
- soldCount?: number;
23463
- /**
23464
- * Paid exists.
23465
- * @readonly
23466
- */
23467
- paidExists?: boolean;
23468
- }
23469
- interface ListEventTicketingSummaryRequest {
23470
- /** Event ID. */
23471
- eventId?: string[];
23472
- }
23473
- interface ListEventTicketingSummaryResponse {
23474
- /** Ticketing summaries. */
23475
- summaries?: EventTicketingSummary[];
23476
- }
23477
- interface EventTicketingSummary {
23478
- /**
23479
- * Event ID to which the ticketing summary belongs.
23480
- * @readonly
23481
- */
23482
- eventId?: string | null;
23483
- /**
23484
- * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
23485
- * @readonly
23486
- */
23487
- _updatedDate?: Date | null;
23488
- /**
23489
- * Whether all tickets are sold for this event.
23490
- * @readonly
23491
- */
23492
- soldOut?: boolean | null;
23493
- /**
23494
- * Price of lowest priced ticket.
23495
- * @readonly
23496
- */
23497
- lowestTicketPrice?: CommonMoney;
23498
- /**
23499
- * Price of highest priced ticket.
23500
- * @readonly
23501
- */
23502
- highestTicketPrice?: CommonMoney;
23503
- /**
23504
- * Currency used in event transactions.
23505
- * @readonly
23506
- */
23507
- currency?: string | null;
23508
- /**
23509
- * Formatted price of lowest priced ticket.
23510
- * @readonly
23511
- */
23512
- lowestTicketPriceFormatted?: string | null;
23513
- /**
23514
- * Formatted price of highest priced ticket.
23515
- * @readonly
23516
- */
23517
- highestTicketPriceFormatted?: string | null;
23518
- }
23519
- interface Empty {
23520
- }
23521
- interface ReservationCreated {
23522
- /** Reservation created timestamp in ISO UTC format. */
23523
- timestamp?: Date | null;
23524
- /** Event ID. */
23525
- eventId?: string;
23526
- /**
23527
- * Reservation ID.
23528
- * Can be used to retrieve a reservation invoice.
23529
- */
23530
- reservationId?: string;
23531
- /** Reservation expiration timestamp. */
23532
- expires?: Date | null;
23533
- /** Reservation status. */
23534
- status?: ReservationStatus;
23535
- /** Reservation ticket quantities. */
23536
- quantities?: TicketQuantity[];
23537
- /** Reservation update timestamp. */
23538
- _updatedDate?: Date | null;
23539
- /** Reservation counts. */
23540
- counts?: ReservationCount[];
23541
- }
23542
- declare enum ReservationStatus {
23543
- /** The Reservation is pending confirmation and will expire after the expiration due time. */
23544
- RESERVATION_PENDING = "RESERVATION_PENDING",
23545
- /** The reservation is confirmed and will not expire. */
23546
- RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
23547
- /** The reservation is canceled because of non payment. */
23548
- RESERVATION_CANCELED = "RESERVATION_CANCELED",
23549
- /** The reservation is canceled manually by the buyer. */
23550
- RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
23551
- /** The reservation is expired. */
23552
- RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
23553
- }
23554
- interface TicketQuantity {
23555
- /** Ticket definition ID. */
23556
- ticketDefinitionId?: string | null;
23557
- /** Quantity. */
23558
- quantity?: number | null;
23559
- /** Quantity update timestamp. */
23560
- _updatedDate?: Date | null;
23561
- }
23562
- interface ReservationCount {
23563
- /** Reservation Count snapshot timestamp. */
23564
- timestamp?: Date | null;
23565
- /** Ticket Definition ID. */
23566
- ticketDefinitionId?: string;
23567
- /** Confirmed reservation count. */
23568
- confirmedCount?: number;
23569
- /** Pending reservation count. */
23570
- pendingCount?: number;
23571
- /** True if paid ticket reservation exist. */
23572
- paidExists?: boolean;
23282
+ interface SalePeriodUpdated {
23283
+ /** Ticket definition sale period after update. */
23284
+ afterUpdate?: SalePeriod;
23573
23285
  }
23574
- interface ReservationUpdated {
23575
- /** Reservation updated timestamp. */
23576
- timestamp?: Date | null;
23577
- /** Event ID. */
23578
- eventId?: string;
23579
- /**
23580
- * Reservation ID.
23581
- * Can be used to retrieve a reservation invoice.
23582
- */
23583
- reservationId?: string;
23584
- /** Reservation status. */
23585
- status?: ReservationStatus;
23586
- /** Reservation expiration timestamp. */
23587
- expires?: Date | null;
23588
- /** Reservation ticket quantities. */
23589
- quantities?: TicketQuantity[];
23590
- /** Reservation update timestamp. */
23591
- _updatedDate?: Date | null;
23592
- /** Reservation counts. */
23593
- counts?: ReservationCount[];
23286
+ interface TicketDefinitionSaleStarted {
23287
+ /** Ticket definition. */
23288
+ ticketDefinition?: TicketDefinition;
23594
23289
  }
23595
- interface EventDeleted {
23596
- /** Event deleted timestamp in ISO UTC format. */
23597
- timestamp?: Date | null;
23598
- /** Event ID. */
23599
- eventId?: string;
23600
- /** Event title. */
23601
- title?: string;
23602
- /** Event creator user ID. */
23603
- userId?: string | null;
23290
+ interface TicketDefinitionSaleEnded {
23291
+ /** Ticket definition. */
23292
+ ticketDefinition?: TicketDefinition;
23604
23293
  }
23605
23294
  interface CreateTicketDefinitionRequest {
23606
23295
  /** Ticket definition info. */
@@ -23825,6 +23514,18 @@ interface CopiedTicketDefinition {
23825
23514
  /** Ticket definition ID. */
23826
23515
  ticketDefinitionId?: string;
23827
23516
  }
23517
+ interface EventDeleted {
23518
+ /** Event deleted timestamp in ISO UTC format. */
23519
+ timestamp?: Date | null;
23520
+ /** Event ID. */
23521
+ eventId?: string;
23522
+ /** Event title. */
23523
+ title?: string;
23524
+ /** Event creator user ID. */
23525
+ userId?: string | null;
23526
+ }
23527
+ interface Empty {
23528
+ }
23828
23529
  interface EventCanceled {
23829
23530
  /** Event canceled timestamp in ISO UTC format. */
23830
23531
  timestamp?: Date | null;
@@ -24793,10 +24494,80 @@ interface CategoryDetails {
24793
24494
  */
24794
24495
  totalCapacity?: number | null;
24795
24496
  /**
24796
- * Already reserved capacity
24797
- * @readonly
24497
+ * Already reserved capacity
24498
+ * @readonly
24499
+ */
24500
+ reserved?: number | null;
24501
+ }
24502
+ interface DomainEvent extends DomainEventBodyOneOf {
24503
+ createdEvent?: EntityCreatedEvent;
24504
+ updatedEvent?: EntityUpdatedEvent;
24505
+ deletedEvent?: EntityDeletedEvent;
24506
+ actionEvent?: ActionEvent;
24507
+ /**
24508
+ * Unique event ID.
24509
+ * Allows clients to ignore duplicate webhooks.
24510
+ */
24511
+ _id?: string;
24512
+ /**
24513
+ * Assumes actions are also always typed to an entity_type
24514
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
24515
+ */
24516
+ entityFqdn?: string;
24517
+ /**
24518
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
24519
+ * This is although the created/updated/deleted notion is duplication of the oneof types
24520
+ * Example: created/updated/deleted/started/completed/email_opened
24521
+ */
24522
+ slug?: string;
24523
+ /** ID of the entity associated with the event. */
24524
+ entityId?: string;
24525
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
24526
+ eventTime?: Date | null;
24527
+ /**
24528
+ * Whether the event was triggered as a result of a privacy regulation application
24529
+ * (for example, GDPR).
24530
+ */
24531
+ triggeredByAnonymizeRequest?: boolean | null;
24532
+ /** If present, indicates the action that triggered the event. */
24533
+ originatedFrom?: string | null;
24534
+ /**
24535
+ * A sequence number defining the order of updates to the underlying entity.
24536
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
24537
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
24538
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
24539
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
24540
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
24541
+ */
24542
+ entityEventSequence?: string | null;
24543
+ }
24544
+ /** @oneof */
24545
+ interface DomainEventBodyOneOf {
24546
+ createdEvent?: EntityCreatedEvent;
24547
+ updatedEvent?: EntityUpdatedEvent;
24548
+ deletedEvent?: EntityDeletedEvent;
24549
+ actionEvent?: ActionEvent;
24550
+ }
24551
+ interface EntityCreatedEvent {
24552
+ entity?: string;
24553
+ }
24554
+ interface RestoreInfo {
24555
+ deletedDate?: Date | null;
24556
+ }
24557
+ interface EntityUpdatedEvent {
24558
+ /**
24559
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
24560
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
24561
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
24798
24562
  */
24799
- reserved?: number | null;
24563
+ currentEntity?: string;
24564
+ }
24565
+ interface EntityDeletedEvent {
24566
+ /** Entity that was deleted */
24567
+ deletedEntity?: string | null;
24568
+ }
24569
+ interface ActionEvent {
24570
+ body?: string;
24800
24571
  }
24801
24572
  interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
24802
24573
  /** Emitted on a meta site creation. */
@@ -25095,6 +24866,210 @@ interface ScheduleLegacyTimeCapsuleTaskRequest {
25095
24866
  /** Definition ID. */
25096
24867
  ticketDefinitionId?: string;
25097
24868
  }
24869
+ interface MessageEnvelope {
24870
+ /** App instance ID. */
24871
+ instanceId?: string | null;
24872
+ /** Event type. */
24873
+ eventType?: string;
24874
+ /** The identification type and identity data. */
24875
+ identity?: IdentificationData;
24876
+ /** Stringify payload. */
24877
+ data?: string;
24878
+ }
24879
+ interface IdentificationData extends IdentificationDataIdOneOf {
24880
+ /** ID of a site visitor that has not logged in to the site. */
24881
+ anonymousVisitorId?: string;
24882
+ /** ID of a site visitor that has logged in to the site. */
24883
+ memberId?: string;
24884
+ /** ID of a Wix user (site owner, contributor, etc.). */
24885
+ wixUserId?: string;
24886
+ /** ID of an app. */
24887
+ appId?: string;
24888
+ /** @readonly */
24889
+ identityType?: WebhookIdentityType;
24890
+ }
24891
+ /** @oneof */
24892
+ interface IdentificationDataIdOneOf {
24893
+ /** ID of a site visitor that has not logged in to the site. */
24894
+ anonymousVisitorId?: string;
24895
+ /** ID of a site visitor that has logged in to the site. */
24896
+ memberId?: string;
24897
+ /** ID of a Wix user (site owner, contributor, etc.). */
24898
+ wixUserId?: string;
24899
+ /** ID of an app. */
24900
+ appId?: string;
24901
+ }
24902
+ declare enum WebhookIdentityType {
24903
+ UNKNOWN = "UNKNOWN",
24904
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
24905
+ MEMBER = "MEMBER",
24906
+ WIX_USER = "WIX_USER",
24907
+ APP = "APP"
24908
+ }
24909
+ interface GetTicketDefinitionSummaryRequest {
24910
+ /** Ticket definition id. */
24911
+ ticketDefinitionId?: string | null;
24912
+ }
24913
+ interface GetTicketDefinitionSummaryResponse {
24914
+ /** Summary. */
24915
+ summary?: TicketDefinitionSummary;
24916
+ }
24917
+ interface TicketDefinitionSummary {
24918
+ /**
24919
+ * Ticket definition ID.
24920
+ * @readonly
24921
+ */
24922
+ definitionId?: string | null;
24923
+ /**
24924
+ * Event ID to which the ticket definition summary belongs.
24925
+ * @readonly
24926
+ */
24927
+ eventId?: string | null;
24928
+ /**
24929
+ * Date and time of the ticket definition summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
24930
+ * @readonly
24931
+ */
24932
+ _updatedDate?: Date | null;
24933
+ /**
24934
+ * Reserved count.
24935
+ * @readonly
24936
+ */
24937
+ reservedCount?: number;
24938
+ /**
24939
+ * Sold count.
24940
+ * @readonly
24941
+ */
24942
+ soldCount?: number;
24943
+ /**
24944
+ * Paid exists.
24945
+ * @readonly
24946
+ */
24947
+ paidExists?: boolean;
24948
+ }
24949
+ interface ListEventTicketingSummaryRequest {
24950
+ /** Event ID. */
24951
+ eventId?: string[];
24952
+ }
24953
+ interface ListEventTicketingSummaryResponse {
24954
+ /** Ticketing summaries. */
24955
+ summaries?: EventTicketingSummary[];
24956
+ }
24957
+ interface EventTicketingSummary {
24958
+ /**
24959
+ * Event ID to which the ticketing summary belongs.
24960
+ * @readonly
24961
+ */
24962
+ eventId?: string | null;
24963
+ /**
24964
+ * Date and time of the ticketing summary latest update in `yyyy-mm-ddThh:mm:sssZ` format.
24965
+ * @readonly
24966
+ */
24967
+ _updatedDate?: Date | null;
24968
+ /**
24969
+ * Whether all tickets are sold for this event.
24970
+ * @readonly
24971
+ */
24972
+ soldOut?: boolean | null;
24973
+ /**
24974
+ * Price of lowest priced ticket.
24975
+ * @readonly
24976
+ */
24977
+ lowestTicketPrice?: CommonMoney;
24978
+ /**
24979
+ * Price of highest priced ticket.
24980
+ * @readonly
24981
+ */
24982
+ highestTicketPrice?: CommonMoney;
24983
+ /**
24984
+ * Currency used in event transactions.
24985
+ * @readonly
24986
+ */
24987
+ currency?: string | null;
24988
+ /**
24989
+ * Formatted price of lowest priced ticket.
24990
+ * @readonly
24991
+ */
24992
+ lowestTicketPriceFormatted?: string | null;
24993
+ /**
24994
+ * Formatted price of highest priced ticket.
24995
+ * @readonly
24996
+ */
24997
+ highestTicketPriceFormatted?: string | null;
24998
+ }
24999
+ interface ReservationCreated {
25000
+ /** Reservation created timestamp in ISO UTC format. */
25001
+ timestamp?: Date | null;
25002
+ /** Event ID. */
25003
+ eventId?: string;
25004
+ /**
25005
+ * Reservation ID.
25006
+ * Can be used to retrieve a reservation invoice.
25007
+ */
25008
+ reservationId?: string;
25009
+ /** Reservation expiration timestamp. */
25010
+ expires?: Date | null;
25011
+ /** Reservation status. */
25012
+ status?: ReservationStatus;
25013
+ /** Reservation ticket quantities. */
25014
+ quantities?: TicketQuantity[];
25015
+ /** Reservation update timestamp. */
25016
+ _updatedDate?: Date | null;
25017
+ /** Reservation counts. */
25018
+ counts?: ReservationCount[];
25019
+ }
25020
+ declare enum ReservationStatus {
25021
+ /** The Reservation is pending confirmation and will expire after the expiration due time. */
25022
+ RESERVATION_PENDING = "RESERVATION_PENDING",
25023
+ /** The reservation is confirmed and will not expire. */
25024
+ RESERVATION_CONFIRMED = "RESERVATION_CONFIRMED",
25025
+ /** The reservation is canceled because of non payment. */
25026
+ RESERVATION_CANCELED = "RESERVATION_CANCELED",
25027
+ /** The reservation is canceled manually by the buyer. */
25028
+ RESERVATION_CANCELED_MANUALLY = "RESERVATION_CANCELED_MANUALLY",
25029
+ /** The reservation is expired. */
25030
+ RESERVATION_EXPIRED = "RESERVATION_EXPIRED"
25031
+ }
25032
+ interface TicketQuantity {
25033
+ /** Ticket definition ID. */
25034
+ ticketDefinitionId?: string | null;
25035
+ /** Quantity. */
25036
+ quantity?: number | null;
25037
+ /** Quantity update timestamp. */
25038
+ _updatedDate?: Date | null;
25039
+ }
25040
+ interface ReservationCount {
25041
+ /** Reservation Count snapshot timestamp. */
25042
+ timestamp?: Date | null;
25043
+ /** Ticket Definition ID. */
25044
+ ticketDefinitionId?: string;
25045
+ /** Confirmed reservation count. */
25046
+ confirmedCount?: number;
25047
+ /** Pending reservation count. */
25048
+ pendingCount?: number;
25049
+ /** True if paid ticket reservation exist. */
25050
+ paidExists?: boolean;
25051
+ }
25052
+ interface ReservationUpdated {
25053
+ /** Reservation updated timestamp. */
25054
+ timestamp?: Date | null;
25055
+ /** Event ID. */
25056
+ eventId?: string;
25057
+ /**
25058
+ * Reservation ID.
25059
+ * Can be used to retrieve a reservation invoice.
25060
+ */
25061
+ reservationId?: string;
25062
+ /** Reservation status. */
25063
+ status?: ReservationStatus;
25064
+ /** Reservation expiration timestamp. */
25065
+ expires?: Date | null;
25066
+ /** Reservation ticket quantities. */
25067
+ quantities?: TicketQuantity[];
25068
+ /** Reservation update timestamp. */
25069
+ _updatedDate?: Date | null;
25070
+ /** Reservation counts. */
25071
+ counts?: ReservationCount[];
25072
+ }
25098
25073
  interface CommonMoneyNonNullableFields {
25099
25074
  value: string;
25100
25075
  currency: string;
@@ -25218,11 +25193,11 @@ interface TicketDefinitionCreatedEnvelope {
25218
25193
  entity: TicketDefinition;
25219
25194
  metadata: EventMetadata;
25220
25195
  }
25221
- interface TicketDefinitionUpdatedEnvelope {
25222
- entity: TicketDefinition;
25196
+ interface TicketDefinitionDeletedEnvelope {
25223
25197
  metadata: EventMetadata;
25224
25198
  }
25225
- interface TicketDefinitionDeletedEnvelope {
25199
+ interface TicketDefinitionSaleEndedEnvelope {
25200
+ data: TicketDefinitionSaleEnded;
25226
25201
  metadata: EventMetadata;
25227
25202
  }
25228
25203
  interface TicketDefinitionSalePeriodUpdatedEnvelope {
@@ -25233,8 +25208,8 @@ interface TicketDefinitionSaleStartedEnvelope {
25233
25208
  data: TicketDefinitionSaleStarted;
25234
25209
  metadata: EventMetadata;
25235
25210
  }
25236
- interface TicketDefinitionSaleEndedEnvelope {
25237
- data: TicketDefinitionSaleEnded;
25211
+ interface TicketDefinitionUpdatedEnvelope {
25212
+ entity: TicketDefinition;
25238
25213
  metadata: EventMetadata;
25239
25214
  }
25240
25215
  interface CreateTicketDefinitionOptions {
@@ -25544,11 +25519,11 @@ interface ChangeCurrencySignature {
25544
25519
  (eventId: string, options: ChangeCurrencyOptions): Promise<void>;
25545
25520
  }
25546
25521
  declare const onTicketDefinitionCreated$1: EventDefinition<TicketDefinitionCreatedEnvelope, "wix.events.v3.ticket_definition_created">;
25547
- declare const onTicketDefinitionUpdated$1: EventDefinition<TicketDefinitionUpdatedEnvelope, "wix.events.v3.ticket_definition_updated">;
25548
25522
  declare const onTicketDefinitionDeleted$1: EventDefinition<TicketDefinitionDeletedEnvelope, "wix.events.v3.ticket_definition_deleted">;
25523
+ declare const onTicketDefinitionSaleEnded$1: EventDefinition<TicketDefinitionSaleEndedEnvelope, "wix.events.v3.ticket_definition_sale_ended">;
25549
25524
  declare const onTicketDefinitionSalePeriodUpdated$1: EventDefinition<TicketDefinitionSalePeriodUpdatedEnvelope, "wix.events.v3.ticket_definition_sale_period_updated">;
25550
25525
  declare const onTicketDefinitionSaleStarted$1: EventDefinition<TicketDefinitionSaleStartedEnvelope, "wix.events.v3.ticket_definition_sale_started">;
25551
- declare const onTicketDefinitionSaleEnded$1: EventDefinition<TicketDefinitionSaleEndedEnvelope, "wix.events.v3.ticket_definition_sale_ended">;
25526
+ declare const onTicketDefinitionUpdated$1: EventDefinition<TicketDefinitionUpdatedEnvelope, "wix.events.v3.ticket_definition_updated">;
25552
25527
 
25553
25528
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
25554
25529
 
@@ -25570,18 +25545,18 @@ type _publicOnTicketDefinitionCreatedType = typeof onTicketDefinitionCreated$1;
25570
25545
  */
25571
25546
  declare const onTicketDefinitionCreated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionCreatedType>>;
25572
25547
 
25573
- type _publicOnTicketDefinitionUpdatedType = typeof onTicketDefinitionUpdated$1;
25574
- /**
25575
- * Triggered when a ticket definition is updated.
25576
- */
25577
- declare const onTicketDefinitionUpdated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionUpdatedType>>;
25578
-
25579
25548
  type _publicOnTicketDefinitionDeletedType = typeof onTicketDefinitionDeleted$1;
25580
25549
  /**
25581
25550
  * Triggered when a ticket definition is deleted.
25582
25551
  */
25583
25552
  declare const onTicketDefinitionDeleted: ReturnType<typeof createEventModule<_publicOnTicketDefinitionDeletedType>>;
25584
25553
 
25554
+ type _publicOnTicketDefinitionSaleEndedType = typeof onTicketDefinitionSaleEnded$1;
25555
+ /**
25556
+ * Triggered when a ticket sale ends. Sales details are not included in the payload.
25557
+ */
25558
+ declare const onTicketDefinitionSaleEnded: ReturnType<typeof createEventModule<_publicOnTicketDefinitionSaleEndedType>>;
25559
+
25585
25560
  type _publicOnTicketDefinitionSalePeriodUpdatedType = typeof onTicketDefinitionSalePeriodUpdated$1;
25586
25561
  /**
25587
25562
  * Triggered when a sale period is updated.
@@ -25594,11 +25569,11 @@ type _publicOnTicketDefinitionSaleStartedType = typeof onTicketDefinitionSaleSta
25594
25569
  */
25595
25570
  declare const onTicketDefinitionSaleStarted: ReturnType<typeof createEventModule<_publicOnTicketDefinitionSaleStartedType>>;
25596
25571
 
25597
- type _publicOnTicketDefinitionSaleEndedType = typeof onTicketDefinitionSaleEnded$1;
25572
+ type _publicOnTicketDefinitionUpdatedType = typeof onTicketDefinitionUpdated$1;
25598
25573
  /**
25599
- * Triggered when a ticket sale ends. Sales details are not included in the payload.
25574
+ * Triggered when a ticket definition is updated.
25600
25575
  */
25601
- declare const onTicketDefinitionSaleEnded: ReturnType<typeof createEventModule<_publicOnTicketDefinitionSaleEndedType>>;
25576
+ declare const onTicketDefinitionUpdated: ReturnType<typeof createEventModule<_publicOnTicketDefinitionUpdatedType>>;
25602
25577
 
25603
25578
  type context_ActionEvent = ActionEvent;
25604
25579
  type context_Address = Address;