@wix/events 1.0.357 → 1.0.359

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.
@@ -16960,21 +16960,24 @@ interface Rsvp {
16960
16960
  /** Event ID to which the RSVP belongs. */
16961
16961
  eventId?: string | null;
16962
16962
  /**
16963
- * Date and time when the RSVP was created in `yyyy-mm-ddThh:mm:sssZ` format.
16963
+ * Date and time when the RSVP was created.
16964
16964
  * @readonly
16965
16965
  */
16966
16966
  _createdDate?: Date | null;
16967
16967
  /**
16968
- * Date and time of the RSVP's latest update in `yyyy-mm-ddThh:mm:sssZ` format.
16968
+ * Date and time when the RSVP was update.
16969
16969
  * @readonly
16970
16970
  */
16971
16971
  _updatedDate?: Date | null;
16972
- /** Site member ID. This field can only be overridden when a user creates RSVP manually, otherwise it's resolved from identity. Overriding member id requires **WIX_EVENTS.MANAGE_RSVP** permission. */
16972
+ /** Site member ID. You can override the field value when updating RSVP. Overriding member ID requires the **WIX_EVENTS.MANAGE_RSVP** permission. */
16973
16973
  memberId?: string | null;
16974
16974
  /** Contact ID of a guest who filled in the RSVP form. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
16975
16975
  contactId?: string | null;
16976
+ /** First name of a guest who filled in the RSVP form. */
16976
16977
  firstName?: string | null;
16978
+ /** Last name of a guest who filled in the RSVP form. */
16977
16979
  lastName?: string | null;
16980
+ /** Email of a guest who filled in the RSVP form. */
16978
16981
  email?: string | null;
16979
16982
  /** Event registration form. */
16980
16983
  form?: FormResponse;
@@ -16991,40 +16994,44 @@ interface Rsvp {
16991
16994
  */
16992
16995
  guestList?: GuestList;
16993
16996
  /**
16994
- * Site language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
16997
+ * Site language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
16995
16998
  * @readonly
16996
16999
  */
16997
17000
  language?: string | null;
16998
17001
  /**
16999
- * Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.
17002
+ * Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.
17000
17003
  * @readonly
17001
17004
  */
17002
17005
  locale?: string | null;
17003
17006
  /**
17004
- * All guests are checked in.
17007
+ * Whether all guests are checked in.
17005
17008
  * @readonly
17006
17009
  */
17007
17010
  fullyCheckedIn?: boolean | null;
17008
17011
  /**
17009
- * Checked in guest count.
17012
+ * How many guests are checked in.
17010
17013
  * @readonly
17011
17014
  */
17012
17015
  checkedInGuestCount?: number | null;
17013
- /** Additional guest information. */
17016
+ /** Additional guest details. */
17014
17017
  additionalGuestDetails?: AdditionalGuestDetails;
17015
- /** Whether the notifications for this RSVP are disabled. */
17018
+ /** Whether the notifications are disabled. */
17016
17019
  disableNotifications?: boolean | null;
17017
17020
  /**
17018
- * The login details for the guest to access the online conference event.
17021
+ * Guest login details for accessing the online conference event.
17019
17022
  * @readonly
17020
17023
  */
17021
17024
  onlineConferencingLogin?: OnlineConferencingLogin;
17022
17025
  /**
17023
- * RSVP is anonymized by GDPR forget.
17026
+ * Whether the RSVP is anonymized.
17024
17027
  * @readonly
17025
17028
  */
17026
17029
  anonymized?: boolean | null;
17027
- /** Data Extensions */
17030
+ /**
17031
+ * Custom field data for the RSVP object.
17032
+ *
17033
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
17034
+ */
17028
17035
  extendedFields?: ExtendedFields$1;
17029
17036
  }
17030
17037
  interface FormResponse {
@@ -17104,6 +17111,7 @@ interface StandardDetails {
17104
17111
  iso31662?: string | null;
17105
17112
  }
17106
17113
  declare enum RsvpStatus {
17114
+ /** Unknown status. This value is not used. */
17107
17115
  UNKNOWN_RSVP_STATUS = "UNKNOWN_RSVP_STATUS",
17108
17116
  /** Guest is attending the event. */
17109
17117
  YES = "YES",
@@ -17113,6 +17121,7 @@ declare enum RsvpStatus {
17113
17121
  WAITLIST = "WAITLIST"
17114
17122
  }
17115
17123
  interface GuestList {
17124
+ /** List of guests. */
17116
17125
  guests?: Guest[];
17117
17126
  }
17118
17127
  interface Guest {
@@ -17126,15 +17135,15 @@ interface Guest {
17126
17135
  guestId?: number | null;
17127
17136
  }
17128
17137
  interface CheckInDetails {
17129
- /** Whether the guest is checked in. */
17138
+ /** Whether the guest has checked in. */
17130
17139
  checkedIn?: boolean | null;
17131
17140
  /** Check-in date. */
17132
17141
  checkInDate?: Date | null;
17133
17142
  }
17134
17143
  interface AdditionalGuestDetails {
17135
- /** Additional guest count. */
17144
+ /** Number of additional guests. */
17136
17145
  guestCount?: number | null;
17137
- /** Additional guest names. */
17146
+ /** Names of additional guests. */
17138
17147
  guestNames?: string[] | null;
17139
17148
  }
17140
17149
  interface OnlineConferencingLogin {
@@ -17163,44 +17172,47 @@ interface ExtendedFields$1 {
17163
17172
  interface SearchRsvpsRequest {
17164
17173
  /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
17165
17174
  search?: CursorSearch;
17166
- /**
17167
- * Predefined sets of fields to return.
17168
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`.
17169
- * - `FORM`: Returns `form`.
17170
- * - `CONTACT_DETAILS`: Returns `email`.
17171
- */
17175
+ /** Predefined sets of fields to return. */
17172
17176
  fields?: RequestedFields$1[];
17173
17177
  }
17174
17178
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
17175
17179
  /**
17176
- * Cursor pointing to page of results.
17177
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
17180
+ * Cursor paging options.
17181
+ *
17182
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
17178
17183
  */
17179
17184
  cursorPaging?: CursorPaging$2;
17180
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
17185
+ /**
17186
+ * Filter object.
17187
+ *
17188
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
17189
+ */
17181
17190
  filter?: Record<string, any> | null;
17182
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
17191
+ /**
17192
+ * Sort object.
17193
+ *
17194
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
17195
+ */
17183
17196
  sort?: Sorting$2[];
17184
- /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
17197
+ /**
17198
+ * Logical groupings of data into facets, with summaries for each facet.
17199
+ * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
17200
+ */
17185
17201
  aggregations?: Aggregation[];
17186
- /** Free text to match in searchable fields */
17202
+ /** Free text to match in searchable fields. */
17187
17203
  search?: SearchDetails;
17188
17204
  /**
17189
- * UTC offset or IANA time zone. Valid values are
17190
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
17191
- * and IANA time zone IDs, such as Europe/Rome
17192
- *
17193
- * Affects all filters and aggregations returned values.
17194
- * You may override this behavior in a specific filter by providing
17195
- * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
17205
+ * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
17206
+ * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
17196
17207
  */
17197
17208
  timeZone?: string | null;
17198
17209
  }
17199
17210
  /** @oneof */
17200
17211
  interface CursorSearchPagingMethodOneOf {
17201
17212
  /**
17202
- * Cursor pointing to page of results.
17203
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
17213
+ * Cursor paging options.
17214
+ *
17215
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
17204
17216
  */
17205
17217
  cursorPaging?: CursorPaging$2;
17206
17218
  }
@@ -17215,111 +17227,130 @@ declare enum SortOrder$2 {
17215
17227
  DESC = "DESC"
17216
17228
  }
17217
17229
  interface Aggregation extends AggregationKindOneOf {
17218
- /** Value aggregation */
17230
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
17219
17231
  value?: ValueAggregation;
17220
- /** Range aggregation */
17232
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
17221
17233
  range?: RangeAggregation;
17222
- /** Scalar aggregation */
17234
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17223
17235
  scalar?: ScalarAggregation;
17224
- /** Date histogram aggregation */
17236
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
17225
17237
  dateHistogram?: DateHistogramAggregation;
17226
- /** Nested aggregation */
17238
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
17227
17239
  nested?: NestedAggregation;
17228
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
17240
+ /** Aggregation name displayed in the return. */
17229
17241
  name?: string | null;
17230
- /** Type of aggregation, client must provide matching aggregation field below */
17242
+ /** Type of aggregation to perform. */
17231
17243
  type?: AggregationType;
17232
- /** Field to aggregate by, use dot notation to specify json path */
17244
+ /**
17245
+ * Field to aggregate by.
17246
+ * Use dot notation to specify a JSON path. For example, `order.address.streetName`.
17247
+ */
17233
17248
  fieldPath?: string;
17234
17249
  }
17235
17250
  /** @oneof */
17236
17251
  interface AggregationKindOneOf {
17237
- /** Value aggregation */
17252
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
17238
17253
  value?: ValueAggregation;
17239
- /** Range aggregation */
17254
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
17240
17255
  range?: RangeAggregation;
17241
- /** Scalar aggregation */
17256
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17242
17257
  scalar?: ScalarAggregation;
17243
- /** Date histogram aggregation */
17258
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
17244
17259
  dateHistogram?: DateHistogramAggregation;
17245
- /** Nested aggregation */
17260
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
17246
17261
  nested?: NestedAggregation;
17247
17262
  }
17248
17263
  interface RangeBucket {
17249
- /** Inclusive lower bound of the range. Required if to is not given */
17264
+ /** Inclusive lower bound of the range. Required if `to` is not given. */
17250
17265
  from?: number | null;
17251
- /** Exclusive upper bound of the range. Required if from is not given */
17266
+ /** Exclusive upper bound of the range. Required if `from` is not given. */
17252
17267
  to?: number | null;
17253
17268
  }
17254
17269
  declare enum SortType {
17255
- /** Should sort by number of matches */
17270
+ /** Number of matches in the results. */
17256
17271
  COUNT = "COUNT",
17257
- /** Should sort by value of the field alphabetically */
17272
+ /** Alphabetically by the field value. */
17258
17273
  VALUE = "VALUE"
17259
17274
  }
17260
17275
  declare enum SortDirection {
17261
- /** Should sort in descending order */
17276
+ /** Descending order. */
17262
17277
  DESC = "DESC",
17263
- /** Should sort in ascending order */
17278
+ /** Ascending order. */
17264
17279
  ASC = "ASC"
17265
17280
  }
17266
17281
  declare enum MissingValues {
17267
- /** Should missing values be excluded from the aggregation results */
17282
+ /** Exclude missing values from the aggregation results. */
17268
17283
  EXCLUDE = "EXCLUDE",
17269
- /** Should missing values be included in the aggregation results */
17284
+ /** Include missing values in the aggregation results. */
17270
17285
  INCLUDE = "INCLUDE"
17271
17286
  }
17272
17287
  interface IncludeMissingValuesOptions {
17273
- /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
17288
+ /**
17289
+ * Specify a custom name for the bucket containing the missing values.
17290
+ * Defaults: `"N/A"` for strings, `0` for integers, and `false` for booleans.
17291
+ */
17274
17292
  addToBucket?: string;
17275
17293
  }
17276
17294
  declare enum ScalarType {
17295
+ /** Unknown scalar type. This value is not used. */
17277
17296
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
17278
- /** Count of distinct values */
17297
+ /** Total number of distinct values. */
17279
17298
  COUNT_DISTINCT = "COUNT_DISTINCT",
17280
- /** Minimum value */
17299
+ /** Minimum value. */
17281
17300
  MIN = "MIN",
17282
- /** Maximum value */
17301
+ /** Maximum value. */
17283
17302
  MAX = "MAX",
17284
- /** Sum of values */
17303
+ /** Sum of values. */
17285
17304
  SUM = "SUM",
17286
- /** Average of values */
17305
+ /** Average of values. */
17287
17306
  AVG = "AVG"
17288
17307
  }
17289
17308
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
17290
- /** Options for including missing values */
17309
+ /**
17310
+ * Whether to include or exclude missing values in the aggregation results.
17311
+ * Default: `EXCLUDE`.
17312
+ */
17291
17313
  includeOptions?: IncludeMissingValuesOptions;
17292
- /** Should sort by number of matches or value of the field */
17314
+ /** Sort type. */
17293
17315
  sortType?: SortType;
17294
- /** Should sort in ascending or descending order */
17316
+ /** Sort direction. */
17295
17317
  sortDirection?: SortDirection;
17296
- /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
17318
+ /**
17319
+ * Number of aggregation results to return.
17320
+ * Min: `1`
17321
+ * Max: `250`
17322
+ * Default: `10`
17323
+ */
17297
17324
  limit?: number | null;
17298
- /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
17325
+ /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
17299
17326
  missingValues?: MissingValues;
17300
17327
  }
17301
17328
  /** @oneof */
17302
17329
  interface ValueAggregationOptionsOneOf {
17303
- /** Options for including missing values */
17330
+ /**
17331
+ * Whether to include or exclude missing values in the aggregation results.
17332
+ * Default: `EXCLUDE`.
17333
+ */
17304
17334
  includeOptions?: IncludeMissingValuesOptions;
17305
17335
  }
17306
17336
  declare enum NestedAggregationType {
17337
+ /** Unknown aggregation type. This value is not used. */
17307
17338
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
17308
- /** An aggregation where result buckets are dynamically built - one per unique value */
17339
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
17309
17340
  VALUE = "VALUE",
17310
- /** An aggregation, where user can define set of ranges - each representing a bucket */
17341
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
17311
17342
  RANGE = "RANGE",
17312
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
17343
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17313
17344
  SCALAR = "SCALAR",
17314
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
17345
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
17315
17346
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
17316
17347
  }
17317
17348
  interface RangeAggregation {
17318
- /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
17349
+ /** List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. */
17319
17350
  buckets?: RangeBucket[];
17320
17351
  }
17321
17352
  interface ScalarAggregation {
17322
- /** Define the operator for the scalar aggregation */
17353
+ /** Operator type for the scalar aggregation. */
17323
17354
  type?: ScalarType;
17324
17355
  }
17325
17356
  interface DateHistogramAggregation {
@@ -17327,81 +17358,82 @@ interface DateHistogramAggregation {
17327
17358
  interval?: Interval;
17328
17359
  }
17329
17360
  declare enum Interval {
17361
+ /** Unknown interval. This value is not used. */
17330
17362
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
17331
- /** Yearly interval */
17332
17363
  YEAR = "YEAR",
17333
- /** Monthly interval */
17334
17364
  MONTH = "MONTH",
17335
- /** Weekly interval */
17336
17365
  WEEK = "WEEK",
17337
- /** Daily interval */
17338
17366
  DAY = "DAY",
17339
- /** Hourly interval */
17340
17367
  HOUR = "HOUR",
17341
- /** Minute interval */
17342
17368
  MINUTE = "MINUTE",
17343
- /** Second interval */
17344
17369
  SECOND = "SECOND"
17345
17370
  }
17346
17371
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
17347
- /** Value aggregation */
17372
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
17348
17373
  value?: ValueAggregation;
17349
- /** Range aggregation */
17374
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
17350
17375
  range?: RangeAggregation;
17351
- /** Scalar aggregation */
17376
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17352
17377
  scalar?: ScalarAggregation;
17353
- /** Date histogram aggregation */
17378
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
17354
17379
  dateHistogram?: DateHistogramAggregation;
17355
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
17380
+ /** Unique, caller-defined aggregation name, returned in `aggregations.results`. */
17356
17381
  name?: string | null;
17357
- /** Type of aggregation, client must provide matching aggregation field below */
17382
+ /** Type of aggregation to perform. The matching aggregation field must be passed. */
17358
17383
  type?: NestedAggregationType;
17359
- /** Field to aggregate by, use dont notation to specify json path */
17384
+ /**
17385
+ * Field to aggregate by.
17386
+ * Use dot notation to specify a JSON path. For example, `order.address.streetName`.
17387
+ */
17360
17388
  fieldPath?: string;
17361
17389
  }
17362
17390
  /** @oneof */
17363
17391
  interface NestedAggregationItemKindOneOf {
17364
- /** Value aggregation */
17392
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
17365
17393
  value?: ValueAggregation;
17366
- /** Range aggregation */
17394
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
17367
17395
  range?: RangeAggregation;
17368
- /** Scalar aggregation */
17396
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17369
17397
  scalar?: ScalarAggregation;
17370
- /** Date histogram aggregation */
17398
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
17371
17399
  dateHistogram?: DateHistogramAggregation;
17372
17400
  }
17373
17401
  declare enum AggregationType {
17402
+ /** Unknown type. This value is not used. */
17374
17403
  UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
17375
- /** An aggregation where result buckets are dynamically built - one per unique value */
17404
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
17376
17405
  VALUE = "VALUE",
17377
- /** An aggregation, where user can define set of ranges - each representing a bucket */
17406
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
17378
17407
  RANGE = "RANGE",
17379
- /** A single-value metric aggregation - e.g. min, max, sum, avg */
17408
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
17380
17409
  SCALAR = "SCALAR",
17381
- /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
17410
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
17382
17411
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
17383
- /** Multi-level aggregation, where each next aggregation is nested within previous one */
17412
+ /** Flattened list of aggregations, where each aggregation is nested within previous one. */
17384
17413
  NESTED = "NESTED"
17385
17414
  }
17386
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
17415
+ /** Flattened list of aggregations, where each aggregation is nested within previous one. */
17387
17416
  interface NestedAggregation {
17388
- /** Flattened list of aggregations, where each next aggregation is nested within previous one */
17417
+ /** Flattened list of aggregations, where each aggregation is nested within previous one. */
17389
17418
  nestedAggregations?: NestedAggregationItem[];
17390
17419
  }
17391
17420
  interface SearchDetails {
17392
- /** Defines how separate search terms in `expression` are combined */
17421
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
17393
17422
  mode?: Mode;
17394
- /** Search term or expression */
17423
+ /** Search term or expression. */
17395
17424
  expression?: string | null;
17396
- /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
17425
+ /**
17426
+ * Fields to search in. If the array is empty, all searchable fields are searched.
17427
+ * Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`.
17428
+ */
17397
17429
  fields?: string[];
17398
- /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
17430
+ /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
17399
17431
  fuzzy?: boolean;
17400
17432
  }
17401
17433
  declare enum Mode {
17402
- /** Any of the search terms must be present */
17434
+ /** At least one of the search terms must be present. */
17403
17435
  OR = "OR",
17404
- /** All search terms must be present */
17436
+ /** Searches by all provided words. */
17405
17437
  AND = "AND"
17406
17438
  }
17407
17439
  interface CursorPaging$2 {
@@ -17416,12 +17448,13 @@ interface CursorPaging$2 {
17416
17448
  cursor?: string | null;
17417
17449
  }
17418
17450
  declare enum RequestedFields$1 {
17451
+ /** Unknown requested field. This value is not used. */
17419
17452
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
17420
- /** Select fields: createdDate, updatedDate, firstName, lastName, totalGuests, guests. */
17453
+ /** Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. */
17421
17454
  DETAILS = "DETAILS",
17422
- /** Select field: form. */
17455
+ /** Returns `form`. */
17423
17456
  FORM = "FORM",
17424
- /** Select field: email. */
17457
+ /** Returns `email`. */
17425
17458
  CONTACT_DETAILS = "CONTACT_DETAILS"
17426
17459
  }
17427
17460
  interface SearchRsvpsResponse {
@@ -17452,210 +17485,208 @@ interface Cursors$2 {
17452
17485
  prev?: string | null;
17453
17486
  }
17454
17487
  interface AggregationData {
17455
- /** key = aggregation name (as derived from search request) */
17488
+ /** List of the aggregated data results. */
17456
17489
  results?: AggregationResults[];
17457
17490
  }
17458
17491
  interface ValueAggregationResult {
17459
- /** Value of the field */
17492
+ /** Value of the field. */
17460
17493
  value?: string;
17461
- /** Count of entities with this value */
17494
+ /** Total number of entities with this value. */
17462
17495
  count?: number;
17463
17496
  }
17464
17497
  interface RangeAggregationResult {
17465
- /** Inclusive lower bound of the range */
17498
+ /** Inclusive lower bound of the range. */
17466
17499
  from?: number | null;
17467
- /** Exclusive upper bound of the range */
17500
+ /** Exclusive upper bound of the range. */
17468
17501
  to?: number | null;
17469
- /** Count of entities in this range */
17502
+ /** Count of entities in this range. */
17470
17503
  count?: number;
17471
17504
  }
17472
17505
  interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
17473
- /** Value aggregation results */
17506
+ /** Value aggregation results. */
17474
17507
  values?: ValueResults;
17475
- /** Range aggregation results */
17508
+ /** Range aggregation results. */
17476
17509
  ranges?: RangeResults;
17477
- /** Scalar aggregation results */
17510
+ /** Scalar aggregation results. */
17478
17511
  scalar?: AggregationResultsScalarResult;
17479
- /** User-defined name of aggregation, matches the one provided in request */
17512
+ /** Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. */
17480
17513
  name?: string;
17481
- /** Type of aggregation that matches result */
17514
+ /** Aggregation type. */
17482
17515
  type?: AggregationType;
17483
- /** Field to aggregate by, matches the one provided in request */
17516
+ /** Field which the data was aggregated by. */
17484
17517
  fieldPath?: string;
17485
17518
  }
17486
17519
  /** @oneof */
17487
17520
  interface NestedAggregationResultsResultOneOf {
17488
- /** Value aggregation results */
17521
+ /** Value aggregation results. */
17489
17522
  values?: ValueResults;
17490
- /** Range aggregation results */
17523
+ /** Range aggregation results. */
17491
17524
  ranges?: RangeResults;
17492
- /** Scalar aggregation results */
17525
+ /** Scalar aggregation results. */
17493
17526
  scalar?: AggregationResultsScalarResult;
17494
17527
  }
17495
17528
  interface ValueResults {
17496
- /** List of value aggregations */
17529
+ /** List of ranges returned in the same order as requested. */
17497
17530
  results?: ValueAggregationResult[];
17498
17531
  }
17499
17532
  interface RangeResults {
17500
- /** List of ranges returned in same order as requested */
17533
+ /** List of ranges returned in same order as requested. */
17501
17534
  results?: RangeAggregationResult[];
17502
17535
  }
17503
17536
  interface AggregationResultsScalarResult {
17504
- /** Type of scalar aggregation */
17537
+ /** Type of scalar aggregation. */
17505
17538
  type?: ScalarType;
17506
- /** Value of the scalar aggregation */
17539
+ /** Value of the scalar aggregation. */
17507
17540
  value?: number;
17508
17541
  }
17509
17542
  interface NestedValueAggregationResult {
17510
- /** Value of the field */
17543
+ /** Value of the field. */
17511
17544
  value?: string;
17512
- /** Nested aggregations */
17545
+ /** Nested aggregations. */
17513
17546
  nestedResults?: NestedAggregationResults;
17514
17547
  }
17515
17548
  interface ValueResult {
17516
- /** Value of the field */
17549
+ /** Value of the field. */
17517
17550
  value?: string;
17518
- /** Count of entities with this value */
17551
+ /** Total number of entities with this value. */
17519
17552
  count?: number | null;
17520
17553
  }
17521
17554
  interface RangeResult {
17522
- /** Inclusive lower bound of the range */
17555
+ /** Inclusive lower bound of the range. */
17523
17556
  from?: number | null;
17524
- /** Exclusive upper bound of the range */
17557
+ /** Exclusive upper bound of the range. */
17525
17558
  to?: number | null;
17526
- /** Count of entities in this range */
17559
+ /** Total number of entities in this range. */
17527
17560
  count?: number | null;
17528
17561
  }
17529
17562
  interface ScalarResult {
17530
- /** Value of the scalar aggregation */
17563
+ /** Value of the scalar aggregation. */
17531
17564
  value?: number;
17532
17565
  }
17533
17566
  interface NestedResultValue extends NestedResultValueResultOneOf {
17534
- /** Value aggregation result */
17567
+ /** Value aggregation result. */
17535
17568
  value?: ValueResult;
17536
- /** Range aggregation result */
17569
+ /** Range aggregation result. */
17537
17570
  range?: RangeResult;
17538
- /** Scalar aggregation result */
17571
+ /** Scalar aggregation result. */
17539
17572
  scalar?: ScalarResult;
17540
- /** Date histogram aggregation result */
17573
+ /** Date histogram aggregation result. */
17541
17574
  dateHistogram?: ValueResult;
17542
17575
  }
17543
17576
  /** @oneof */
17544
17577
  interface NestedResultValueResultOneOf {
17545
- /** Value aggregation result */
17578
+ /** Value aggregation result. */
17546
17579
  value?: ValueResult;
17547
- /** Range aggregation result */
17580
+ /** Range aggregation result. */
17548
17581
  range?: RangeResult;
17549
- /** Scalar aggregation result */
17582
+ /** Scalar aggregation result. */
17550
17583
  scalar?: ScalarResult;
17551
- /** Date histogram aggregation result */
17584
+ /** Date histogram aggregation result. */
17552
17585
  dateHistogram?: ValueResult;
17553
17586
  }
17554
17587
  interface Results {
17555
- /** List of nested aggregations */
17588
+ /** List of nested aggregations. */
17556
17589
  results?: Record<string, NestedResultValue>;
17557
17590
  }
17558
17591
  interface DateHistogramResult {
17559
- /** Date in ISO 8601 format */
17592
+ /** Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */
17560
17593
  value?: string;
17561
- /** Count of documents in the bucket */
17594
+ /** Total number of entities in the bucket. */
17562
17595
  count?: number;
17563
17596
  }
17564
17597
  interface GroupByValueResults {
17565
- /** List of value aggregations */
17598
+ /** List of value aggregations. */
17566
17599
  results?: NestedValueAggregationResult[];
17567
17600
  }
17568
17601
  interface DateHistogramResults {
17569
- /** List of date histogram aggregations */
17602
+ /** List of date histogram aggregations. */
17570
17603
  results?: DateHistogramResult[];
17571
17604
  }
17572
- /**
17573
- * Results of `NESTED` aggregation type in a flattened form
17574
- * aggregations in resulting array are keyed by requested aggregation `name`.
17575
- */
17605
+ /** Results of `NESTED` aggregation type in a flattened array, identifiable by the requested aggregation `name`. */
17576
17606
  interface NestedResults {
17577
- /** List of nested aggregations */
17607
+ /** List of nested aggregations. */
17578
17608
  results?: Results[];
17579
17609
  }
17580
17610
  interface AggregationResults extends AggregationResultsResultOneOf {
17581
- /** Value aggregation results */
17611
+ /** Value aggregation results. */
17582
17612
  values?: ValueResults;
17583
- /** Range aggregation results */
17613
+ /** Range aggregation results. */
17584
17614
  ranges?: RangeResults;
17585
- /** Scalar aggregation results */
17615
+ /** Scalar aggregation results. */
17586
17616
  scalar?: AggregationResultsScalarResult;
17587
- /** Group by value aggregation results */
17617
+ /** Group by value aggregation results. */
17588
17618
  groupedByValue?: GroupByValueResults;
17589
- /** Date histogram aggregation results */
17619
+ /** Date histogram aggregation results. */
17590
17620
  dateHistogram?: DateHistogramResults;
17591
- /** Nested aggregation results */
17621
+ /** Nested aggregation results. */
17592
17622
  nested?: NestedResults;
17593
- /** User-defined name of aggregation as derived from search request */
17623
+ /** Aggregation name displayed in the return. */
17594
17624
  name?: string;
17595
- /** Type of aggregation that must match provided kind as derived from search request */
17625
+ /** Type of aggregation that was performed. */
17596
17626
  type?: AggregationType;
17597
- /** Field to aggregate by as derived from search request */
17627
+ /** Field which the data was aggregated by. */
17598
17628
  fieldPath?: string;
17599
17629
  }
17600
17630
  /** @oneof */
17601
17631
  interface AggregationResultsResultOneOf {
17602
- /** Value aggregation results */
17632
+ /** Value aggregation results. */
17603
17633
  values?: ValueResults;
17604
- /** Range aggregation results */
17634
+ /** Range aggregation results. */
17605
17635
  ranges?: RangeResults;
17606
- /** Scalar aggregation results */
17636
+ /** Scalar aggregation results. */
17607
17637
  scalar?: AggregationResultsScalarResult;
17608
- /** Group by value aggregation results */
17638
+ /** Group by value aggregation results. */
17609
17639
  groupedByValue?: GroupByValueResults;
17610
- /** Date histogram aggregation results */
17640
+ /** Date histogram aggregation results. */
17611
17641
  dateHistogram?: DateHistogramResults;
17612
- /** Nested aggregation results */
17642
+ /** Nested aggregation results. */
17613
17643
  nested?: NestedResults;
17614
17644
  }
17615
17645
  interface SearchRsvpsWithOffsetRequest {
17616
17646
  /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
17617
17647
  search?: Search;
17618
- /**
17619
- * Predefined sets of fields to return.
17620
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`.
17621
- * - `FORM`: Returns `form`.
17622
- * - `CONTACT_DETAILS`: Returns `email`.
17623
- */
17648
+ /** Predefined sets of fields to return. */
17624
17649
  fields?: RequestedFields$1[];
17625
17650
  }
17626
17651
  interface Search extends SearchPagingMethodOneOf {
17627
- /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
17652
+ /** Paging options to limit and offset the number of items. */
17628
17653
  paging?: Paging$2;
17629
- /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
17654
+ /** 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. */
17630
17655
  cursorPaging?: CursorPaging$2;
17631
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
17656
+ /**
17657
+ * Filter object.
17658
+ *
17659
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
17660
+ */
17632
17661
  filter?: Record<string, any> | null;
17633
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
17662
+ /**
17663
+ * Sort object.
17664
+ *
17665
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
17666
+ */
17634
17667
  sort?: Sorting$2[];
17635
- /** Projection on the result object - list of specific field names to return. If fieldsets are also specified, return the union of fieldsets and fields */
17668
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
17636
17669
  fields?: string[];
17637
- /** Projection on the result object - list of named projections. E.g. "basic" will return id and name fields. Specifying multiple fieldsets will return the union of fields from all. Specifying fieldsets and fields will also return the union of fields. */
17670
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
17638
17671
  fieldsets?: string[];
17639
- /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
17672
+ /**
17673
+ * Logical groupings of data into facets, with summaries for each facet.
17674
+ * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
17675
+ */
17640
17676
  aggregations?: Aggregation[];
17641
- /** Free text to match in searchable fields */
17677
+ /** Free text to match in searchable fields. */
17642
17678
  search?: SearchDetails;
17643
17679
  /**
17644
- * UTC offset or IANA time zone. Valid values are
17645
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
17646
- * and IANA time zone IDs, such as Europe/Rome
17647
- *
17648
- * Affects all filters and aggregations returned values.
17649
- * You may override this behavior in a specific filter by providing
17650
- * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
17680
+ * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
17681
+ * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
17651
17682
  */
17652
17683
  timeZone?: string | null;
17653
17684
  }
17654
17685
  /** @oneof */
17655
17686
  interface SearchPagingMethodOneOf {
17656
- /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
17687
+ /** Paging options to limit and offset the number of items. */
17657
17688
  paging?: Paging$2;
17658
- /** Cursor pointing to page of results. Can't be used together with 'paging'. 'cursor_paging.cursor' can not be used together with 'filter' or 'sort' */
17689
+ /** 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. */
17659
17690
  cursorPaging?: CursorPaging$2;
17660
17691
  }
17661
17692
  interface Paging$2 {
@@ -17687,12 +17718,7 @@ interface PagingMetadataV2$2 {
17687
17718
  interface QueryRsvpsRequest {
17688
17719
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
17689
17720
  query?: CursorQuery;
17690
- /**
17691
- * Predefined sets of fields to return.
17692
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`.
17693
- * - `FORM`: Returns `form`.
17694
- * - `CONTACT_DETAILS`: Returns `email`.
17695
- */
17721
+ /** Predefined sets of fields to return. */
17696
17722
  fields?: RequestedFields$1[];
17697
17723
  }
17698
17724
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -17725,24 +17751,26 @@ interface QueryRsvpsResponse {
17725
17751
  pagingMetadata?: CursorPagingMetadata;
17726
17752
  }
17727
17753
  interface CountRsvpsRequest {
17728
- /** Filter to filter the RSVPs. */
17754
+ /**
17755
+ * Filter object in the following format:
17756
+ * `"filter" : {
17757
+ * "fieldName1": "value1",
17758
+ * "fieldName2":{"$operator":"value2"}
17759
+ * }`
17760
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
17761
+ */
17729
17762
  filter?: Record<string, any> | null;
17730
17763
  /** Search details. */
17731
17764
  search?: SearchDetails;
17732
17765
  }
17733
17766
  interface CountRsvpsResponse {
17734
- /** The amount of RSVPs that match the request. */
17767
+ /** Number of RSVPs. */
17735
17768
  count?: number;
17736
17769
  }
17737
17770
  interface GetRsvpRequest {
17738
17771
  /** RSVP ID. */
17739
17772
  rsvpId: string;
17740
- /**
17741
- * Predefined sets of fields to return.
17742
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17743
- * - `FORM`: Returns `form`.
17744
- * - `CONTACT_DETAILS`: Returns `email`.
17745
- */
17773
+ /** Predefined sets of fields to return. */
17746
17774
  fields?: RequestedFields$1[];
17747
17775
  }
17748
17776
  interface GetRsvpResponse {
@@ -17754,12 +17782,7 @@ interface CreateRsvpRequest {
17754
17782
  rsvp: Rsvp;
17755
17783
  /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
17756
17784
  options?: ModificationOptions;
17757
- /**
17758
- * Predefined sets of fields to return.
17759
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17760
- * - `FORM`: Returns `form`.
17761
- * - `CONTACT_DETAILS`: Returns `email`.
17762
- */
17785
+ /** Predefined sets of fields to return. */
17763
17786
  fields?: RequestedFields$1[];
17764
17787
  }
17765
17788
  interface ModificationOptions {
@@ -17769,7 +17792,7 @@ interface ModificationOptions {
17769
17792
  ignoreFormValidation?: boolean;
17770
17793
  /** Whether to ignore response status. */
17771
17794
  ignoreResponseStatus?: boolean;
17772
- /** Whether to ignore additional guest name validation. */
17795
+ /** Whether to ignore additional guest names validation. */
17773
17796
  ignoreAdditionalGuestNames?: boolean;
17774
17797
  }
17775
17798
  interface CreateRsvpResponse {
@@ -17791,14 +17814,9 @@ interface GuestLimitExceededData {
17791
17814
  interface UpdateRsvpRequest {
17792
17815
  /** RSVP to update. */
17793
17816
  rsvp: Rsvp;
17794
- /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
17817
+ /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */
17795
17818
  options?: ModificationOptions;
17796
- /**
17797
- * Predefined sets of fields to return.
17798
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17799
- * - `FORM`: Returns `form`.
17800
- * - `CONTACT_DETAILS`: Returns `email`.
17801
- */
17819
+ /** Predefined sets of fields to return. */
17802
17820
  fields?: RequestedFields$1[];
17803
17821
  }
17804
17822
  interface UpdateRsvpResponse {
@@ -17812,26 +17830,21 @@ interface DeleteRsvpRequest {
17812
17830
  interface DeleteRsvpResponse {
17813
17831
  }
17814
17832
  interface BulkUpdateRsvpRequest {
17815
- /** RSVPs to be updated. */
17833
+ /** RSVPs to update. */
17816
17834
  rsvps: MaskedRsvp[];
17817
17835
  /** Whether to return the whole `rsvp` object in the response. If `false`, only metadata is returned. */
17818
17836
  returnEntity?: boolean;
17819
- /**
17820
- * Predefined sets of fields to return.
17821
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17822
- * - `FORM`: Returns `form`.
17823
- * - `CONTACT_DETAILS`: Returns `email`.
17824
- */
17837
+ /** Predefined sets of fields to return. */
17825
17838
  fields?: RequestedFields$1[];
17826
- /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
17839
+ /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */
17827
17840
  options?: ModificationOptions;
17828
17841
  }
17829
17842
  interface MaskedRsvp {
17830
- /** RSVP to be updated, may be partial */
17843
+ /** RSVP to update. */
17831
17844
  rsvp?: Rsvp;
17832
17845
  }
17833
17846
  interface BulkUpdateRsvpResponse {
17834
- /** Bulk update results. */
17847
+ /** Response of bulk update. */
17835
17848
  results?: BulkRsvpResult[];
17836
17849
  /** Response metadata. */
17837
17850
  bulkActionMetadata?: BulkActionMetadata;
@@ -17875,20 +17888,15 @@ interface BulkDeleteRsvpsByFilterRequest {
17875
17888
  search?: SearchDetails;
17876
17889
  }
17877
17890
  interface BulkDeleteRsvpsByFilterResponse {
17878
- /** Endpoint job ID. */
17891
+ /** Job ID. Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */
17879
17892
  jobId?: string;
17880
17893
  }
17881
17894
  interface CheckInRsvpGuestsRequest {
17882
- /** RSVP ID to check-in. */
17895
+ /** ID of RSVP to check-in. */
17883
17896
  rsvpId: string | null;
17884
- /** Guest IDs to check-in. */
17897
+ /** IDs of guests to check-in. */
17885
17898
  guestIds?: number[];
17886
- /**
17887
- * Predefined sets of fields to return.
17888
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17889
- * - `FORM`: Returns `form`.
17890
- * - `CONTACT_DETAILS`: Returns `email`.
17891
- */
17899
+ /** Predefined sets of fields to return. */
17892
17900
  fields?: RequestedFields$1[];
17893
17901
  }
17894
17902
  interface CheckInRsvpGuestsResponse {
@@ -17896,16 +17904,11 @@ interface CheckInRsvpGuestsResponse {
17896
17904
  rsvp?: Rsvp;
17897
17905
  }
17898
17906
  interface CancelRsvpGuestsCheckInRequest {
17899
- /** RSVP ID to cancel check-in. */
17907
+ /** ID of RSVP to cancel check-in. */
17900
17908
  rsvpId: string;
17901
- /** Guest IDs to cancel check-in. */
17909
+ /** IDs of guests to check-in. */
17902
17910
  guestIds?: number[];
17903
- /**
17904
- * Predefined sets of fields to return.
17905
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
17906
- * - `FORM`: Returns `form`.
17907
- * - `CONTACT_DETAILS`: Returns `email`.
17908
- */
17911
+ /** Predefined sets of fields to return. */
17909
17912
  fields?: RequestedFields$1[];
17910
17913
  }
17911
17914
  interface CancelRsvpGuestsCheckInResponse {
@@ -17917,32 +17920,32 @@ interface ListRsvpSummaryRequest {
17917
17920
  eventId: string[] | null;
17918
17921
  }
17919
17922
  interface ListRsvpSummaryResponse {
17920
- /** Rsvp summaries. */
17923
+ /** List of RSVP summary. */
17921
17924
  summaries?: V2RsvpSummary[];
17922
17925
  }
17923
17926
  interface V2RsvpSummary {
17924
17927
  /**
17925
- * Event id.
17928
+ * Event ID.
17926
17929
  * @readonly
17927
17930
  */
17928
17931
  eventId?: string | null;
17929
17932
  /**
17930
- * Yes count.
17933
+ * Number of RSVPs that answered `yes`.
17931
17934
  * @readonly
17932
17935
  */
17933
17936
  yesGuestCount?: number | null;
17934
17937
  /**
17935
- * No count.
17938
+ * Number of RSVPs that answered `no`.
17936
17939
  * @readonly
17937
17940
  */
17938
17941
  noGuestCount?: number | null;
17939
17942
  /**
17940
- * Waitlist count.
17943
+ * Number of RSVPs that are in the waitlist.
17941
17944
  * @readonly
17942
17945
  */
17943
17946
  waitlistGuestCount?: number | null;
17944
17947
  /**
17945
- * Total rsvp count.
17948
+ * Total number of RSVPs.
17946
17949
  * @readonly
17947
17950
  */
17948
17951
  totalRsvpCount?: number | null;
@@ -19163,21 +19166,11 @@ interface RsvpUpdatedEnvelope {
19163
19166
  interface SearchRsvpsOptions {
19164
19167
  /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
19165
19168
  search?: CursorSearch;
19166
- /**
19167
- * Predefined sets of fields to return.
19168
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`.
19169
- * - `FORM`: Returns `form`.
19170
- * - `CONTACT_DETAILS`: Returns `email`.
19171
- */
19169
+ /** Predefined sets of fields to return. */
19172
19170
  fields?: RequestedFields$1[];
19173
19171
  }
19174
19172
  interface QueryRsvpsOptions {
19175
- /**
19176
- * Predefined sets of fields to return.
19177
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`.
19178
- * - `FORM`: Returns `form`.
19179
- * - `CONTACT_DETAILS`: Returns `email`.
19180
- */
19173
+ /** Predefined sets of fields to return. */
19181
19174
  fields?: RequestedFields$1[] | undefined;
19182
19175
  }
19183
19176
  interface QueryCursorResult$1 {
@@ -19248,29 +19241,26 @@ interface RsvpsQueryBuilder {
19248
19241
  find: () => Promise<RsvpsQueryResult>;
19249
19242
  }
19250
19243
  interface CountRsvpsOptions {
19251
- /** Filter to filter the RSVPs. */
19244
+ /**
19245
+ * Filter object in the following format:
19246
+ * `"filter" : {
19247
+ * "fieldName1": "value1",
19248
+ * "fieldName2":{"$operator":"value2"}
19249
+ * }`
19250
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
19251
+ */
19252
19252
  filter?: Record<string, any> | null;
19253
19253
  /** Search details. */
19254
19254
  search?: SearchDetails;
19255
19255
  }
19256
19256
  interface GetRsvpOptions {
19257
- /**
19258
- * Predefined sets of fields to return.
19259
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19260
- * - `FORM`: Returns `form`.
19261
- * - `CONTACT_DETAILS`: Returns `email`.
19262
- */
19257
+ /** Predefined sets of fields to return. */
19263
19258
  fields?: RequestedFields$1[];
19264
19259
  }
19265
19260
  interface CreateRsvpOptions {
19266
19261
  /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
19267
19262
  options?: ModificationOptions;
19268
- /**
19269
- * Predefined sets of fields to return.
19270
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19271
- * - `FORM`: Returns `form`.
19272
- * - `CONTACT_DETAILS`: Returns `email`.
19273
- */
19263
+ /** Predefined sets of fields to return. */
19274
19264
  fields?: RequestedFields$1[];
19275
19265
  }
19276
19266
  interface UpdateRsvp {
@@ -19287,21 +19277,24 @@ interface UpdateRsvp {
19287
19277
  /** Event ID to which the RSVP belongs. */
19288
19278
  eventId?: string | null;
19289
19279
  /**
19290
- * Date and time when the RSVP was created in `yyyy-mm-ddThh:mm:sssZ` format.
19280
+ * Date and time when the RSVP was created.
19291
19281
  * @readonly
19292
19282
  */
19293
19283
  _createdDate?: Date | null;
19294
19284
  /**
19295
- * Date and time of the RSVP's latest update in `yyyy-mm-ddThh:mm:sssZ` format.
19285
+ * Date and time when the RSVP was update.
19296
19286
  * @readonly
19297
19287
  */
19298
19288
  _updatedDate?: Date | null;
19299
- /** Site member ID. This field can only be overridden when a user creates RSVP manually, otherwise it's resolved from identity. Overriding member id requires **WIX_EVENTS.MANAGE_RSVP** permission. */
19289
+ /** Site member ID. You can override the field value when updating RSVP. Overriding member ID requires the **WIX_EVENTS.MANAGE_RSVP** permission. */
19300
19290
  memberId?: string | null;
19301
19291
  /** Contact ID of a guest who filled in the RSVP form. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
19302
19292
  contactId?: string | null;
19293
+ /** First name of a guest who filled in the RSVP form. */
19303
19294
  firstName?: string | null;
19295
+ /** Last name of a guest who filled in the RSVP form. */
19304
19296
  lastName?: string | null;
19297
+ /** Email of a guest who filled in the RSVP form. */
19305
19298
  email?: string | null;
19306
19299
  /** Event registration form. */
19307
19300
  form?: FormResponse;
@@ -19318,64 +19311,58 @@ interface UpdateRsvp {
19318
19311
  */
19319
19312
  guestList?: GuestList;
19320
19313
  /**
19321
- * Site language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
19314
+ * Site language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
19322
19315
  * @readonly
19323
19316
  */
19324
19317
  language?: string | null;
19325
19318
  /**
19326
- * Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.
19319
+ * Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.
19327
19320
  * @readonly
19328
19321
  */
19329
19322
  locale?: string | null;
19330
19323
  /**
19331
- * All guests are checked in.
19324
+ * Whether all guests are checked in.
19332
19325
  * @readonly
19333
19326
  */
19334
19327
  fullyCheckedIn?: boolean | null;
19335
19328
  /**
19336
- * Checked in guest count.
19329
+ * How many guests are checked in.
19337
19330
  * @readonly
19338
19331
  */
19339
19332
  checkedInGuestCount?: number | null;
19340
- /** Additional guest information. */
19333
+ /** Additional guest details. */
19341
19334
  additionalGuestDetails?: AdditionalGuestDetails;
19342
- /** Whether the notifications for this RSVP are disabled. */
19335
+ /** Whether the notifications are disabled. */
19343
19336
  disableNotifications?: boolean | null;
19344
19337
  /**
19345
- * The login details for the guest to access the online conference event.
19338
+ * Guest login details for accessing the online conference event.
19346
19339
  * @readonly
19347
19340
  */
19348
19341
  onlineConferencingLogin?: OnlineConferencingLogin;
19349
19342
  /**
19350
- * RSVP is anonymized by GDPR forget.
19343
+ * Whether the RSVP is anonymized.
19351
19344
  * @readonly
19352
19345
  */
19353
19346
  anonymized?: boolean | null;
19354
- /** Data Extensions */
19347
+ /**
19348
+ * Custom field data for the RSVP object.
19349
+ *
19350
+ * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.
19351
+ */
19355
19352
  extendedFields?: ExtendedFields$1;
19356
19353
  }
19357
19354
  interface UpdateRsvpOptions {
19358
- /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
19355
+ /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */
19359
19356
  options?: ModificationOptions;
19360
- /**
19361
- * Predefined sets of fields to return.
19362
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19363
- * - `FORM`: Returns `form`.
19364
- * - `CONTACT_DETAILS`: Returns `email`.
19365
- */
19357
+ /** Predefined sets of fields to return. */
19366
19358
  fields?: RequestedFields$1[];
19367
19359
  }
19368
19360
  interface BulkUpdateRsvpOptions {
19369
19361
  /** Whether to return the whole `rsvp` object in the response. If `false`, only metadata is returned. */
19370
19362
  returnEntity?: boolean;
19371
- /**
19372
- * Predefined sets of fields to return.
19373
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19374
- * - `FORM`: Returns `form`.
19375
- * - `CONTACT_DETAILS`: Returns `email`.
19376
- */
19363
+ /** Predefined sets of fields to return. */
19377
19364
  fields?: RequestedFields$1[];
19378
- /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required. */
19365
+ /** RSVP options. <br> The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */
19379
19366
  options?: ModificationOptions;
19380
19367
  }
19381
19368
  interface BulkDeleteRsvpsByFilterOptions {
@@ -19383,37 +19370,23 @@ interface BulkDeleteRsvpsByFilterOptions {
19383
19370
  search?: SearchDetails;
19384
19371
  }
19385
19372
  interface CheckInRsvpGuestsOptions {
19386
- /** Guest IDs to check-in. */
19373
+ /** IDs of guests to check-in. */
19387
19374
  guestIds?: number[];
19388
- /**
19389
- * Predefined sets of fields to return.
19390
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19391
- * - `FORM`: Returns `form`.
19392
- * - `CONTACT_DETAILS`: Returns `email`.
19393
- */
19375
+ /** Predefined sets of fields to return. */
19394
19376
  fields?: RequestedFields$1[];
19395
19377
  }
19396
19378
  interface CancelRsvpGuestsCheckInOptions {
19397
- /** Guest IDs to cancel check-in. */
19379
+ /** IDs of guests to check-in. */
19398
19380
  guestIds?: number[];
19399
- /**
19400
- * Predefined sets of fields to return.
19401
- * - `DETAILS`: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guestList`.
19402
- * - `FORM`: Returns `form`.
19403
- * - `CONTACT_DETAILS`: Returns `email`.
19404
- */
19381
+ /** Predefined sets of fields to return. */
19405
19382
  fields?: RequestedFields$1[];
19406
19383
  }
19407
19384
 
19408
19385
  declare function searchRsvps$1(httpClient: HttpClient): SearchRsvpsSignature;
19409
19386
  interface SearchRsvpsSignature {
19410
19387
  /**
19411
- * Retrieves a list of RSVPs with aggregation data, given the provided paging, filtering, and sorting.
19412
- * Search RSVP runs with these defaults, which you can override:
19413
- * - `createdDate` is sorted in `ASC` order
19414
- * - `paging.limit` is `100`
19415
- * - `paging.offset` is `0`
19416
- * For field support for filters and sorting, see [RSVP v2: Supported Filters and Sorting]().
19388
+ * Retrieves a list of RSVPs that match the provided search query and optionally performs aggregations on the data queried.
19389
+ *
19417
19390
  * To learn about working with _Search_ 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).
19418
19391
  */
19419
19392
  (options?: SearchRsvpsOptions | undefined): Promise<SearchRsvpsResponse & SearchRsvpsResponseNonNullableFields>;
@@ -19421,18 +19394,28 @@ interface SearchRsvpsSignature {
19421
19394
  declare function queryRsvps$1(httpClient: HttpClient): QueryRsvpsSignature;
19422
19395
  interface QueryRsvpsSignature {
19423
19396
  /**
19424
- * Returns list of rsvp by filter. Most optimal queries:
19425
- * {"eventId" and "status"}
19426
- * {"eventId" and "fullyCheckedIn"}
19427
- * {"eventId" and "memberId"}
19428
- * {"contactId" and "eventId"}
19429
- * {"createdDate" and "eventId"}
19397
+ * Retrieves a list of RSVPs, given the provided paging, filtering, and sorting. Query RSVPs runs with these defaults, which you can override:
19398
+ *
19399
+ * - `createdDate` is sorted in `ASC` order
19400
+ * - `paging.limit` is `100`
19401
+ * - `paging.offset` is `0`
19402
+ *
19403
+ * For field support for filters and sorting, see [RSVP v2: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/filter-and-sort). To learn about working with Query endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
19404
+ *
19405
+ * > **Note:** This method is quite slow. We suggest you using the following filter pairs for the most optimal speed:
19406
+ * > - `eventId` and `status`
19407
+ * > - `eventId` and `fullyCheckedIn`
19408
+ * > - `eventId` and `memberId`
19409
+ * > - `eventId` and `contactId`
19410
+ * > - `eventId` and `createdDate`
19430
19411
  */
19431
19412
  (options?: QueryRsvpsOptions | undefined): RsvpsQueryBuilder;
19432
19413
  }
19433
19414
  declare function countRsvps$1(httpClient: HttpClient): CountRsvpsSignature;
19434
19415
  interface CountRsvpsSignature {
19435
- /** */
19416
+ /**
19417
+ * Counts RSVPs given the provided filtering and searching.
19418
+ */
19436
19419
  (options?: CountRsvpsOptions | undefined): Promise<CountRsvpsResponse & CountRsvpsResponseNonNullableFields>;
19437
19420
  }
19438
19421
  declare function getRsvp$1(httpClient: HttpClient): GetRsvpSignature;
@@ -19447,8 +19430,9 @@ interface GetRsvpSignature {
19447
19430
  declare function createRsvp$1(httpClient: HttpClient): CreateRsvpSignature;
19448
19431
  interface CreateRsvpSignature {
19449
19432
  /**
19450
- * Creates RSVP. <br> <br>
19451
- * To create RSVP with multiple guests, you have to define `additionalGuests` and `guestNames` as form fields. The `additionalGuests` value is how many additional guests are in the RSVP, and `guestNames` is an array of full guest names.
19433
+ * Creates RSVP.
19434
+ *
19435
+ * To create RSVP with multiple guests, you have to specify the `additionalGuests` and `guestNames` fields.
19452
19436
  * @param - RSVP info.
19453
19437
  * @returns Created RSVP.
19454
19438
  */
@@ -19457,7 +19441,8 @@ interface CreateRsvpSignature {
19457
19441
  declare function updateRsvp$1(httpClient: HttpClient): UpdateRsvpSignature;
19458
19442
  interface UpdateRsvpSignature {
19459
19443
  /**
19460
- * Updates RSVP. <br> <br>
19444
+ * Updates RSVP.
19445
+ *
19461
19446
  * Each time the RSVP is updated, `revision` increments by 1. The existing `revision` must be included when updating the RSVP. This ensures you're working with the latest RSVP and prevents unintended overwrites.
19462
19447
  * @param - RSVP ID.
19463
19448
  * @returns Updated RSVP.
@@ -19475,17 +19460,17 @@ interface DeleteRsvpSignature {
19475
19460
  declare function bulkUpdateRsvp$1(httpClient: HttpClient): BulkUpdateRsvpSignature;
19476
19461
  interface BulkUpdateRsvpSignature {
19477
19462
  /**
19478
- * Updates multiple RSVPs. <br> <br>
19463
+ * Updates multiple RSVPs.
19464
+ *
19479
19465
  * You can update up to 100 RSVPs per request.
19480
- * @param - RSVPs to be updated.
19466
+ * @param - RSVPs to update.
19481
19467
  */
19482
19468
  (rsvps: MaskedRsvp[], options?: BulkUpdateRsvpOptions | undefined): Promise<BulkUpdateRsvpResponse & BulkUpdateRsvpResponseNonNullableFields>;
19483
19469
  }
19484
19470
  declare function bulkDeleteRsvpsByFilter$1(httpClient: HttpClient): BulkDeleteRsvpsByFilterSignature;
19485
19471
  interface BulkDeleteRsvpsByFilterSignature {
19486
19472
  /**
19487
- * Permanently deletes multiple RSVPs that meet the given criteria. <br> <br>
19488
- * If you send the request with an empty filter, you'll get the "filter must not be empty" error.
19473
+ * Permanently deletes multiple RSVPs by filter.
19489
19474
  * @param - Filter object.
19490
19475
  */
19491
19476
  (filter: Record<string, any> | null, options?: BulkDeleteRsvpsByFilterOptions | undefined): Promise<BulkDeleteRsvpsByFilterResponse & BulkDeleteRsvpsByFilterResponseNonNullableFields>;
@@ -19493,19 +19478,22 @@ interface BulkDeleteRsvpsByFilterSignature {
19493
19478
  declare function checkInRsvpGuests$1(httpClient: HttpClient): CheckInRsvpGuestsSignature;
19494
19479
  interface CheckInRsvpGuestsSignature {
19495
19480
  /**
19496
- * Checks in RSVP guests. <br> <br>
19481
+ * Checks in RSVP guests.
19482
+ *
19497
19483
  * You can check in up to 11 guests per request.
19498
- * @param - RSVP ID to check-in.
19484
+ * @param - ID of RSVP to check-in.
19499
19485
  */
19500
19486
  (rsvpId: string | null, options?: CheckInRsvpGuestsOptions | undefined): Promise<CheckInRsvpGuestsResponse & CheckInRsvpGuestsResponseNonNullableFields>;
19501
19487
  }
19502
19488
  declare function cancelRsvpGuestsCheckIn$1(httpClient: HttpClient): CancelRsvpGuestsCheckInSignature;
19503
19489
  interface CancelRsvpGuestsCheckInSignature {
19504
19490
  /**
19505
- * Cancels the check-in for RSVP guests. <br> <br>
19506
- * If the request body is empty, cancels all check-ins from the RSVP. After the cancellation, the `guests.checkInDate` value becomes empty. <br> <br>
19507
- * You can cancel check-in for up to 11 guests per request.
19508
- * @param - RSVP ID to cancel check-in.
19491
+ * Cancels the check-in of RSVP guests.
19492
+ *
19493
+ * If the request body is empty, cancels all check-ins from the RSVP. After the cancellation, the `guests.checkInDate` value becomes empty.
19494
+ *
19495
+ * You can cancel check-in of up to 11 guests per request.
19496
+ * @param - ID of RSVP to cancel check-in.
19509
19497
  */
19510
19498
  (rsvpId: string, options?: CancelRsvpGuestsCheckInOptions | undefined): Promise<CancelRsvpGuestsCheckInResponse & CancelRsvpGuestsCheckInResponseNonNullableFields>;
19511
19499
  }
@@ -19537,15 +19525,21 @@ declare const cancelRsvpGuestsCheckIn: MaybeContext<BuildRESTFunction<typeof can
19537
19525
  declare const listRsvpSummary: MaybeContext<BuildRESTFunction<typeof listRsvpSummary$1> & typeof listRsvpSummary$1>;
19538
19526
 
19539
19527
  type _publicOnRsvpCreatedType = typeof onRsvpCreated$1;
19540
- /** */
19528
+ /**
19529
+ * Triggered when RSVP is created.
19530
+ */
19541
19531
  declare const onRsvpCreated: ReturnType<typeof createEventModule$2<_publicOnRsvpCreatedType>>;
19542
19532
 
19543
19533
  type _publicOnRsvpDeletedType = typeof onRsvpDeleted$1;
19544
- /** */
19534
+ /**
19535
+ * Triggered when RSVP is deleted.
19536
+ */
19545
19537
  declare const onRsvpDeleted: ReturnType<typeof createEventModule$2<_publicOnRsvpDeletedType>>;
19546
19538
 
19547
19539
  type _publicOnRsvpUpdatedType = typeof onRsvpUpdated$1;
19548
- /** */
19540
+ /**
19541
+ * Triggered when RSVP is updated.
19542
+ */
19549
19543
  declare const onRsvpUpdated: ReturnType<typeof createEventModule$2<_publicOnRsvpUpdatedType>>;
19550
19544
 
19551
19545
  type index_d$2_AdditionalGuestDetails = AdditionalGuestDetails;