@wix/calendar 1.0.54 → 1.0.55

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.
@@ -1056,29 +1056,100 @@ interface DeleteTargetsRequest {
1056
1056
  }
1057
1057
  interface DeleteTargetsResponse {
1058
1058
  }
1059
- interface ListEventsByContactIdRequest {
1059
+ interface GetEventRequest {
1060
1060
  /**
1061
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1062
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1061
+ * ID of the event to retrieve.
1062
+ *
1063
+ * Min: 36 characters
1064
+ * Max: 250 characters
1063
1065
  */
1064
- contactId: string | null;
1066
+ eventId: string | null;
1067
+ /**
1068
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1069
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1070
+ * `America/New_York` or `UTC`.
1071
+ *
1072
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1073
+ */
1074
+ timeZone?: string | null;
1075
+ /**
1076
+ * Information about which fields containing personal data to return. Refer to the
1077
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1078
+ * for more information.
1079
+ *
1080
+ * Supported values:
1081
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1082
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1083
+ *
1084
+ * Max: 1 field
1085
+ * Default: No personal data is returned.
1086
+ */
1087
+ fields?: RequestedFields$1[];
1088
+ }
1089
+ declare enum RequestedFields$1 {
1090
+ UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
1091
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
1092
+ PI_FIELDS = "PI_FIELDS",
1093
+ /** Returns only fields containing your own personal data. */
1094
+ OWN_PI_FIELDS = "OWN_PI_FIELDS"
1095
+ }
1096
+ interface GetEventResponse {
1097
+ /** Retrieved event. */
1098
+ event?: Event$1;
1099
+ }
1100
+ interface ListEventsRequest {
1101
+ /**
1102
+ * IDs of the events to retrieve.
1103
+ *
1104
+ * Min: 1 event ID
1105
+ * Min: 100 event IDs
1106
+ */
1107
+ eventIds: string[];
1108
+ /**
1109
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1110
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1111
+ * `America/New_York` or `UTC`.
1112
+ *
1113
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1114
+ */
1115
+ timeZone?: string | null;
1116
+ /**
1117
+ * Information about which fields containing personal data to return. Refer to the
1118
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1119
+ * for more information.
1120
+ *
1121
+ * Supported values:
1122
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1123
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1124
+ *
1125
+ * Max: 1 field
1126
+ * Default: No personal data is returned.
1127
+ */
1128
+ fields?: RequestedFields$1[];
1129
+ }
1130
+ interface ListEventsResponse {
1131
+ /** Retrieved events matching the provided IDs. */
1132
+ events?: Event$1[];
1133
+ }
1134
+ interface QueryEventsRequest {
1065
1135
  /**
1066
1136
  * Local start date and time from which events are returned in
1067
1137
  * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1068
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1138
+ * `2024-01-30T13:30:00`.
1069
1139
  *
1070
1140
  * Events that start before the `fromLocalDate` but end after it are included in
1071
- * the results. Must be earlier than `toLocalDate`.
1141
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
1142
+ * descending.
1072
1143
  */
1073
1144
  fromLocalDate?: string | null;
1074
1145
  /**
1075
1146
  * Local end date and time up to which events are returned in
1076
1147
  * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1077
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1078
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1148
+ * `2024-01-30T13:30:00`.
1079
1149
  *
1080
1150
  * Events that start before `toLocalDate` but end after it are included in the
1081
- * results. Must be later than `fromLocalDate`.
1151
+ * results. Must be later than `fromLocalDate` unless the sort order is
1152
+ * descending.
1082
1153
  */
1083
1154
  toLocalDate?: string | null;
1084
1155
  /**
@@ -1089,19 +1160,74 @@ interface ListEventsByContactIdRequest {
1089
1160
  * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1090
1161
  */
1091
1162
  timeZone?: string | null;
1163
+ /** Query containing filters and paging. */
1164
+ query?: CursorQuery$2;
1092
1165
  /**
1093
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1094
- * to filter events by.
1166
+ * Filters events based on their `recurrenceType`.
1167
+ *
1168
+ * Max: 5 recurrence types can be specified.
1169
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
1095
1170
  */
1096
- appId?: string | null;
1097
- /** Cursor to retrieve the next page of the results. */
1098
- cursorPaging?: CommonCursorPaging;
1171
+ recurrenceType?: RecurrenceType$1[];
1172
+ /**
1173
+ * Information about which fields containing personal data to return. Refer to the
1174
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1175
+ * for more information.
1176
+ *
1177
+ * Supported values:
1178
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1179
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1180
+ *
1181
+ * Max: 1 field
1182
+ * Default: No personal data is returned.
1183
+ */
1184
+ fields?: RequestedFields$1[];
1099
1185
  }
1100
1186
  /** TODO Diverge */
1101
- interface CommonCursorPaging {
1187
+ interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
1188
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1189
+ cursorPaging?: CursorPaging$2;
1190
+ /**
1191
+ * Filter object.
1192
+ * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
1193
+ * for more information.
1194
+ *
1195
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
1196
+ *
1197
+ * For a detailed list of supported filters, see Supported Filters.
1198
+ */
1199
+ filter?: Record<string, any> | null;
1200
+ /**
1201
+ * Whether to sort events by their start date in ascending order or by their end date in descending order.
1202
+ * Default is start ascending.
1203
+ */
1204
+ sort?: Sorting[];
1205
+ }
1206
+ /** @oneof */
1207
+ interface CursorQueryPagingMethodOneOf$2 {
1208
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1209
+ cursorPaging?: CursorPaging$2;
1210
+ }
1211
+ /** TODO Diverge */
1212
+ interface Sorting {
1213
+ /**
1214
+ * The field to sort by.
1215
+ * Either `start` or `end`.
1216
+ * Default is `start`.
1217
+ */
1218
+ fieldName?: string;
1219
+ /** Sort order. */
1220
+ order?: SortOrder;
1221
+ }
1222
+ declare enum SortOrder {
1223
+ ASC = "ASC",
1224
+ DESC = "DESC"
1225
+ }
1226
+ /** TODO Diverge */
1227
+ interface CursorPaging$2 {
1102
1228
  /**
1103
1229
  * Number of events to return.
1104
- * Defaults to `50`. Maximum `100`.
1230
+ * Defaults to `50`. Maximum `1000`.
1105
1231
  */
1106
1232
  limit?: number | null;
1107
1233
  /**
@@ -1113,18 +1239,18 @@ interface CommonCursorPaging {
1113
1239
  */
1114
1240
  cursor?: string | null;
1115
1241
  }
1116
- interface ListEventsByContactIdResponse {
1117
- /** Retrieved events. */
1242
+ interface QueryEventsResponse {
1243
+ /** Retrieved events matching the provided query. */
1118
1244
  events?: Event$1[];
1119
1245
  /** Paging metadata. */
1120
- pagingMetadata?: CommonCursorPagingMetadata;
1246
+ pagingMetadata?: CursorPagingMetadata$2;
1121
1247
  }
1122
1248
  /** TODO Diverge */
1123
- interface CommonCursorPagingMetadata {
1249
+ interface CursorPagingMetadata$2 {
1124
1250
  /** Number of items returned in the response. */
1125
1251
  count?: number | null;
1126
1252
  /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
1127
- cursors?: CommonCursors;
1253
+ cursors?: Cursors$2;
1128
1254
  /**
1129
1255
  * Indicates if there are more results after the current page.
1130
1256
  * If `true`, another page of results can be retrieved.
@@ -1132,328 +1258,342 @@ interface CommonCursorPagingMetadata {
1132
1258
  */
1133
1259
  hasNext?: boolean | null;
1134
1260
  }
1135
- interface CommonCursors {
1261
+ interface Cursors$2 {
1136
1262
  /** Cursor pointing to next page in the list of results. */
1137
1263
  next?: string | null;
1138
1264
  }
1139
- interface ListEventsByMemberIdRequest {
1265
+ interface ListRecurringEventInstancesHistoryRequest {
1140
1266
  /**
1141
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1142
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1143
- * Provide `me` to retrieve events for the currently logged-in member.
1144
- * You must have the `Read Calendars - Including PI`
1145
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1146
- * to retrieve events for members who aren't the currently logged in member.
1267
+ * The ID of the recurring event.
1268
+ * Required, unless `cursorPaging` is provided.
1147
1269
  */
1148
- memberId: string | null;
1270
+ recurringEventId?: string | null;
1149
1271
  /**
1150
- * Local start date and time from which events are returned in
1151
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1152
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1153
- *
1154
- * Events that start before the `fromLocalDate` but end after it are included in
1155
- * the results. Must be earlier than `toLocalDate`.
1272
+ * The revision of the recurring event.
1273
+ * Required, unless `cursorPaging` is provided.
1156
1274
  */
1157
- fromLocalDate?: string | null;
1275
+ revision?: string | null;
1158
1276
  /**
1159
- * Local end date and time up to which events are returned in
1160
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1161
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1162
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1163
- *
1164
- * Events that start before `toLocalDate` but end after it are included in the
1165
- * results. Must be later than `fromLocalDate`.
1277
+ * Inclusive start date for which events are returned, in ISO-8601 format.
1278
+ * Events that begin at or after the `fromDate` are included in the results.
1279
+ * Required, unless `cursorPaging` is provided.
1166
1280
  */
1167
- toLocalDate?: string | null;
1281
+ fromDate?: Date | null;
1282
+ /**
1283
+ * Exclusive end date for which events are returned, in ISO-8601 format.
1284
+ * Events that begin before the `toDate` are included in the results.
1285
+ * Required, unless `cursorPaging` is provided.
1286
+ */
1287
+ toDate?: Date | null;
1288
+ /** Optional cursor pointing to the next page of events. */
1289
+ cursorPaging?: CursorPaging$2;
1290
+ }
1291
+ interface ListRecurringEventInstancesHistoryResponse {
1292
+ /** The recurring event instances. */
1293
+ recurringEventInstances?: Event$1[];
1294
+ /** Paging metadata. */
1295
+ pagingMetadata?: CursorPagingMetadata$2;
1296
+ }
1297
+ interface CreateEventRequest {
1298
+ /** Event to create. */
1299
+ event: Event$1;
1168
1300
  /**
1169
1301
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1170
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1171
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1302
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1303
+ * `America/New_York` or `UTC`.
1172
1304
  *
1173
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1305
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1174
1306
  */
1175
1307
  timeZone?: string | null;
1176
1308
  /**
1177
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1178
- * to filter events by.
1309
+ * Idempotency key guaranteeing that you don't create the same event more
1310
+ * than once.
1179
1311
  */
1180
- appId?: string | null;
1181
- /** Cursor to retrieve the next page of the results. */
1182
- cursorPaging?: CommonCursorPaging;
1312
+ idempotencyKey?: string | null;
1313
+ }
1314
+ interface CreateEventResponse {
1315
+ /** Created event. */
1316
+ event?: Event$1;
1317
+ }
1318
+ interface BulkCreateEventRequest {
1319
+ /** Events to create. */
1320
+ events: MaskedEvent[];
1183
1321
  /**
1184
- * IDs of the events to retrieve.
1185
- * If you provide a list of IDs, all other filters are ignored.
1322
+ * Whether to return created events.
1186
1323
  *
1187
- * Max: 100 `eventId`s
1324
+ * Default: `false`.
1188
1325
  */
1189
- eventIds?: string[];
1190
- }
1191
- interface ListEventsByMemberIdResponse {
1192
- /** Retrieved events. */
1193
- events?: Event$1[];
1194
- /** Paging metadata. */
1195
- pagingMetadata?: CommonCursorPagingMetadata;
1326
+ returnEntity?: boolean | null;
1327
+ /**
1328
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1329
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1330
+ * `America/New_York` or `UTC`.
1331
+ *
1332
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1333
+ */
1334
+ timeZone?: string | null;
1196
1335
  }
1197
- /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
1198
- interface SitePropertiesNotification$2 {
1199
- /** The site ID for which this update notification applies. */
1200
- metasiteId?: string;
1201
- /** The actual update event. */
1202
- event?: SitePropertiesEvent$2;
1203
- /** A convenience set of mappings from the MetaSite ID to its constituent services. */
1204
- translations?: Translation$2[];
1205
- /** Context of the notification */
1206
- changeContext?: ChangeContext$2;
1336
+ interface MaskedEvent {
1337
+ /** Event to create. */
1338
+ event?: Event$1;
1207
1339
  }
1208
- /** The actual update event for a particular notification. */
1209
- interface SitePropertiesEvent$2 {
1210
- /** Version of the site's properties represented by this update. */
1211
- version?: number;
1212
- /** Updated properties. */
1213
- properties?: Properties$2;
1340
+ interface BulkCreateEventResponse {
1341
+ /** The result for each event, containing the event and whether the action was successful. */
1342
+ results?: BulkEventResult[];
1343
+ /** Total successes and failures. */
1344
+ bulkActionMetadata?: BulkActionMetadata;
1214
1345
  }
1215
- interface Properties$2 {
1216
- /** Site categories. */
1217
- categories?: Categories$2;
1218
- /** Site locale. */
1219
- locale?: Locale$2;
1346
+ interface BulkEventResult {
1347
+ /** Whether the requested action was successful. */
1348
+ itemMetadata?: ItemMetadata;
1349
+ /** The event. */
1350
+ item?: Event$1;
1351
+ }
1352
+ interface ItemMetadata {
1220
1353
  /**
1221
- * Site language.
1222
- *
1223
- * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1354
+ * Event ID.
1355
+ * Should always be available, unless it's impossible (for example, when failing to create an event).
1224
1356
  */
1225
- language?: string | null;
1357
+ _id?: string | null;
1358
+ /** Index of the item within the request array, for correlation between request and response items. */
1359
+ originalIndex?: number;
1226
1360
  /**
1227
- * Site currency format used to bill customers.
1361
+ * Whether the requested action was successful for this event.
1362
+ * When `false`, the `error` field is populated.
1363
+ */
1364
+ success?: boolean;
1365
+ /** Details about the error in case of failure. */
1366
+ error?: ApplicationError;
1367
+ }
1368
+ interface ApplicationError {
1369
+ /** Error code. */
1370
+ code?: string;
1371
+ /** Description of the error. */
1372
+ description?: string;
1373
+ /** Data related to the error. */
1374
+ data?: Record<string, any> | null;
1375
+ }
1376
+ interface BulkActionMetadata {
1377
+ /** Number of events that were successfully processed. */
1378
+ totalSuccesses?: number;
1379
+ /** Number of events that couldn't be processed. */
1380
+ totalFailures?: number;
1381
+ }
1382
+ interface UpdateEventRequest {
1383
+ /** Event to update. */
1384
+ event: Event$1;
1385
+ /**
1386
+ * Information about whether participants of the updated event are notified and
1387
+ * the message they receive.
1388
+ */
1389
+ participantNotification?: ParticipantNotification$1;
1390
+ /**
1391
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1392
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1393
+ * `America/New_York` or `UTC`.
1228
1394
  *
1229
- * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1395
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1230
1396
  */
1231
- paymentCurrency?: string | null;
1232
- /** Timezone in `America/New_York` format. */
1233
1397
  timeZone?: string | null;
1234
- /** Email address. */
1235
- email?: string | null;
1236
- /** Phone number. */
1237
- phone?: string | null;
1238
- /** Fax number. */
1239
- fax?: string | null;
1240
- /** Address. */
1241
- address?: Address$2;
1242
- /** Site display name. */
1243
- siteDisplayName?: string | null;
1244
- /** Business name. */
1245
- businessName?: string | null;
1246
- /** Path to the site's logo in Wix Media (without Wix Media base URL). */
1247
- logo?: string | null;
1248
- /** Site description. */
1249
- description?: string | null;
1398
+ }
1399
+ interface ParticipantNotification$1 {
1250
1400
  /**
1251
- * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1401
+ * Whether to notify the participants about changes made to the schedule or event.
1252
1402
  *
1253
- * __Note:__ Not supported by Wix Bookings.
1403
+ * Default: `false`
1254
1404
  */
1255
- businessSchedule?: BusinessSchedule$2;
1256
- /** Supported languages of a site and the primary language. */
1257
- multilingual?: Multilingual$2;
1258
- /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
1259
- consentPolicy?: ConsentPolicy$2;
1405
+ notifyParticipants?: boolean | null;
1260
1406
  /**
1261
- * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1407
+ * Message to send.
1262
1408
  *
1263
- * Site business type.
1409
+ * Min: 1 character
1410
+ * Max: 5000 characters
1264
1411
  */
1265
- businessConfig?: string | null;
1266
- /** External site url that uses Wix as its headless business solution */
1267
- externalSiteUrl?: string | null;
1268
- /** Track clicks analytics */
1269
- trackClicksAnalytics?: boolean;
1270
- }
1271
- interface Categories$2 {
1272
- /** Primary site category. */
1273
- primary?: string;
1274
- /** Secondary site category. */
1275
- secondary?: string[];
1276
- /** Business Term Id */
1277
- businessTermId?: string | null;
1278
- }
1279
- interface Locale$2 {
1280
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1281
- languageCode?: string;
1282
- /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1283
- country?: string;
1284
- }
1285
- interface Address$2 {
1286
- /** Street name. */
1287
- street?: string;
1288
- /** City name. */
1289
- city?: string;
1290
- /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1291
- country?: string;
1292
- /** State. */
1293
- state?: string;
1294
- /** Zip or postal code. */
1295
- zip?: string;
1296
- /** Extra information to be displayed in the address. */
1297
- hint?: AddressHint$2;
1298
- /** Whether this address represents a physical location. */
1299
- isPhysical?: boolean;
1300
- /** Google-formatted version of this address. */
1301
- googleFormattedAddress?: string;
1302
- /** Street number. */
1303
- streetNumber?: string;
1304
- /** Apartment number. */
1305
- apartmentNumber?: string;
1306
- /** Geographic coordinates of location. */
1307
- coordinates?: GeoCoordinates$2;
1308
- }
1309
- /**
1310
- * Extra information on displayed addresses.
1311
- * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1312
- * Free text. In addition the user can state where he wants that additional description - before, after, or instead
1313
- * the address string.
1314
- */
1315
- interface AddressHint$2 {
1316
- /** Extra text displayed next to, or instead of, the actual address. */
1317
- text?: string;
1318
- /** Where the extra text should be displayed. */
1319
- placement?: PlacementType$2;
1320
- }
1321
- /** Where the extra text should be displayed: before, after or instead of the actual address. */
1322
- declare enum PlacementType$2 {
1323
- BEFORE = "BEFORE",
1324
- AFTER = "AFTER",
1325
- REPLACE = "REPLACE"
1326
- }
1327
- /** Geocoordinates for a particular address. */
1328
- interface GeoCoordinates$2 {
1329
- /** Latitude of the location. Must be between -90 and 90. */
1330
- latitude?: number;
1331
- /** Longitude of the location. Must be between -180 and 180. */
1332
- longitude?: number;
1412
+ message?: string | null;
1333
1413
  }
1334
- /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1335
- interface BusinessSchedule$2 {
1336
- /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
1337
- periods?: TimePeriod$2[];
1338
- /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
1339
- specialHourPeriod?: SpecialHourPeriod$2[];
1414
+ interface UpdateEventResponse {
1415
+ /** Updated event. */
1416
+ event?: Event$1;
1340
1417
  }
1341
- /** Weekly recurring time periods when the business is regularly open or the service is available. */
1342
- interface TimePeriod$2 {
1343
- /** Day of the week the period starts on. */
1344
- openDay?: DayOfWeek$2;
1418
+ /** `PRIVATE` until we'll have standard events metadata from Infra. */
1419
+ interface EventUpdatedWithMetadata {
1420
+ /** The updated event. */
1421
+ event?: Event$1;
1345
1422
  /**
1346
- * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1347
- * midnight at the end of the specified day.
1423
+ * Information about whether participants of the updated event are notified and
1424
+ * the message they receive.
1348
1425
  */
1349
- openTime?: string;
1350
- /** Day of the week the period ends on. */
1351
- closeDay?: DayOfWeek$2;
1426
+ participantNotification?: ParticipantNotification$1;
1427
+ }
1428
+ interface BulkUpdateEventRequest {
1352
1429
  /**
1353
- * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1354
- * midnight at the end of the specified day.
1430
+ * Events to update.
1355
1431
  *
1356
- * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1432
+ * Min: 1 event
1433
+ * Max: 50 events
1357
1434
  */
1358
- closeTime?: string;
1359
- }
1360
- /** Enumerates the days of the week. */
1361
- declare enum DayOfWeek$2 {
1362
- MONDAY = "MONDAY",
1363
- TUESDAY = "TUESDAY",
1364
- WEDNESDAY = "WEDNESDAY",
1365
- THURSDAY = "THURSDAY",
1366
- FRIDAY = "FRIDAY",
1367
- SATURDAY = "SATURDAY",
1368
- SUNDAY = "SUNDAY"
1369
- }
1370
- /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1371
- interface SpecialHourPeriod$2 {
1372
- /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1373
- startDate?: string;
1374
- /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1375
- endDate?: string;
1435
+ events: BulkUpdateEventRequestMaskedEvent[];
1376
1436
  /**
1377
- * Whether the business is closed (or the service is not available) during the exception.
1437
+ * Whether to return the updated events.
1378
1438
  *
1379
- * Default: `true`.
1439
+ * Default: `false`
1380
1440
  */
1381
- isClosed?: boolean;
1382
- /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1383
- comment?: string;
1384
- }
1385
- interface Multilingual$2 {
1386
- /** Supported languages list. */
1387
- supportedLanguages?: SupportedLanguage$2[];
1388
- /** Whether to redirect to user language. */
1389
- autoRedirect?: boolean;
1441
+ returnEntity?: boolean | null;
1442
+ /**
1443
+ * Information about whether participants of the updated event are notified and
1444
+ * the message they receive.
1445
+ */
1446
+ participantNotification?: ParticipantNotification$1;
1447
+ /**
1448
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1449
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1450
+ * `America/New_York` or `UTC`.
1451
+ *
1452
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1453
+ */
1454
+ timeZone?: string | null;
1390
1455
  }
1391
- interface SupportedLanguage$2 {
1392
- /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1393
- languageCode?: string;
1394
- /** Locale. */
1395
- locale?: Locale$2;
1396
- /** Whether the supported language is the primary language for the site. */
1397
- isPrimary?: boolean;
1398
- /** Language icon. */
1399
- countryCode?: string;
1400
- /** How the language will be resolved. For internal use. */
1401
- resolutionMethod?: ResolutionMethod$2;
1456
+ interface BulkUpdateEventRequestMaskedEvent {
1457
+ /** Event to update. */
1458
+ event?: Event$1;
1402
1459
  }
1403
- declare enum ResolutionMethod$2 {
1404
- QUERY_PARAM = "QUERY_PARAM",
1405
- SUBDOMAIN = "SUBDOMAIN",
1406
- SUBDIRECTORY = "SUBDIRECTORY"
1460
+ interface BulkUpdateEventResponse {
1461
+ /** The result for each event, containing the event and whether the action was successful. */
1462
+ results?: BulkEventResult[];
1463
+ /** Total successes and failures. */
1464
+ bulkActionMetadata?: BulkActionMetadata;
1407
1465
  }
1408
- interface ConsentPolicy$2 {
1409
- /** Whether the site uses cookies that are essential to site operation. */
1410
- essential?: boolean | null;
1411
- /** Whether the site uses cookies that affect site performance and other functional measurements. */
1412
- functional?: boolean | null;
1413
- /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
1414
- analytics?: boolean | null;
1415
- /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
1416
- advertising?: boolean | null;
1417
- /** CCPA compliance flag. */
1418
- dataToThirdParty?: boolean | null;
1466
+ interface UpdateEventParticipantsRequest {
1467
+ /**
1468
+ * ID of the event to update.
1469
+ *
1470
+ * Min: 36 characters
1471
+ * Max: 250 characters
1472
+ */
1473
+ eventId?: string | null;
1474
+ /** The participants to update. */
1475
+ participants?: Participants$1;
1419
1476
  }
1420
- /** A single mapping from the MetaSite ID to a particular service. */
1421
- interface Translation$2 {
1422
- /** The service type. */
1423
- serviceType?: string;
1424
- /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1425
- appDefId?: string;
1426
- /** The instance ID of the service. */
1427
- instanceId?: string;
1477
+ interface UpdateEventParticipantsResponse {
1478
+ /** Updated event. */
1479
+ event?: Event$1;
1428
1480
  }
1429
- interface ChangeContext$2 extends ChangeContextPayloadOneOf$2 {
1430
- /** Properties were updated. */
1431
- propertiesChange?: PropertiesChange$2;
1432
- /** Default properties were created on site creation. */
1433
- siteCreated?: SiteCreated$2;
1434
- /** Properties were cloned on site cloning. */
1435
- siteCloned?: SiteCloned$2;
1481
+ interface RestoreEventDefaultsRequest {
1482
+ /** ID of the event for which to restore default values. */
1483
+ eventId: string | null;
1484
+ /**
1485
+ * Fields for which to restore default values.
1486
+ *
1487
+ * `TIME` restores default values for `start` and `end`.
1488
+ *
1489
+ * Min: 1 field
1490
+ */
1491
+ fields: Field$1[];
1492
+ /**
1493
+ * Information about whether participants of the updated event are notified and
1494
+ * the message they receive.
1495
+ */
1496
+ participantNotification?: ParticipantNotification$1;
1497
+ /**
1498
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1499
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1500
+ * `America/New_York` or `UTC`.
1501
+ *
1502
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1503
+ */
1504
+ timeZone?: string | null;
1436
1505
  }
1437
- /** @oneof */
1438
- interface ChangeContextPayloadOneOf$2 {
1439
- /** Properties were updated. */
1440
- propertiesChange?: PropertiesChange$2;
1441
- /** Default properties were created on site creation. */
1442
- siteCreated?: SiteCreated$2;
1443
- /** Properties were cloned on site cloning. */
1444
- siteCloned?: SiteCloned$2;
1506
+ interface RestoreEventDefaultsResponse {
1507
+ /** Updated event. */
1508
+ event?: Event$1;
1445
1509
  }
1446
- interface PropertiesChange$2 {
1510
+ interface SplitRecurringEventRequest {
1511
+ /** ID of the `MASTER` event to split. */
1512
+ recurringEventId: string | null;
1513
+ /**
1514
+ * Local date and time at which the `MASTER` event is split in
1515
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1516
+ * `2025-03-11T09:00:00`.
1517
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
1518
+ * `EXCEPTION` event in the series. Additionally, there must be another
1519
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
1520
+ * wouldn't affect any event without a subsequent occurrence.
1521
+ */
1522
+ splitLocalDate: string | null;
1523
+ /**
1524
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1525
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1526
+ * `America/New_York` or `UTC`.
1527
+ *
1528
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1529
+ */
1530
+ timeZone?: string | null;
1447
1531
  }
1448
- interface SiteCreated$2 {
1449
- /** Origin template site id. */
1450
- originTemplateId?: string | null;
1532
+ interface SplitRecurringEventResponse {
1533
+ /** Original `MASTER` event that was shortened. */
1534
+ updatedRecurringEventEndingBeforeSplit?: Event$1;
1535
+ /** New `MASTER` event starting with the first event after the split date. */
1536
+ newRecurringEventStartingFromSplit?: Event$1;
1451
1537
  }
1452
- interface SiteCloned$2 {
1453
- /** Origin site id. */
1454
- originMetaSiteId?: string;
1538
+ interface RecurringEventSplit {
1539
+ /** Original `MASTER` event that was shortened. */
1540
+ updatedRecurringEventEndingBeforeSplit?: Event$1;
1541
+ /** New `MASTER` event starting with the first event after the split date. */
1542
+ newRecurringEventStartingFromSplit?: Event$1;
1455
1543
  }
1456
- interface Empty$4 {
1544
+ interface CancelEventRequest {
1545
+ /** ID of the event to cancel. */
1546
+ eventId: string | null;
1547
+ /**
1548
+ * Information about whether participants of the canceled event are notified and
1549
+ * the message they receive.
1550
+ */
1551
+ participantNotification?: ParticipantNotification$1;
1552
+ /**
1553
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1554
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1555
+ * `America/New_York` or `UTC`.
1556
+ *
1557
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1558
+ */
1559
+ timeZone?: string | null;
1560
+ }
1561
+ interface CancelEventResponse {
1562
+ /** Canceled event. */
1563
+ event?: Event$1;
1564
+ }
1565
+ interface EventCancelled {
1566
+ /** Canceled event. */
1567
+ event?: Event$1;
1568
+ }
1569
+ interface BulkCancelEventRequest {
1570
+ /** IDs of the events to cancel. */
1571
+ eventIds: string[];
1572
+ /**
1573
+ * Whether to return the canceled events.
1574
+ *
1575
+ * Default: `false`
1576
+ */
1577
+ returnEntity?: boolean | null;
1578
+ /**
1579
+ * Information about whether participants of the canceled events are notified and
1580
+ * the message they receive.
1581
+ */
1582
+ participantNotification?: ParticipantNotification$1;
1583
+ /**
1584
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1585
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1586
+ * `America/New_York` or `UTC`.
1587
+ *
1588
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1589
+ */
1590
+ timeZone?: string | null;
1591
+ }
1592
+ interface BulkCancelEventResponse {
1593
+ /** The result for each event, containing the event and whether the action was successful. */
1594
+ results?: BulkEventResult[];
1595
+ /** Total successes and failures. */
1596
+ bulkActionMetadata?: BulkActionMetadata;
1457
1597
  }
1458
1598
  interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
1459
1599
  createdEvent?: EntityCreatedEvent$4;
@@ -1525,584 +1665,444 @@ interface EntityDeletedEvent$4 {
1525
1665
  interface ActionEvent$4 {
1526
1666
  body?: string;
1527
1667
  }
1528
- interface GetEventRequest {
1529
- /**
1530
- * ID of the event to retrieve.
1531
- *
1532
- * Min: 36 characters
1533
- * Max: 250 characters
1534
- */
1535
- eventId: string | null;
1536
- /**
1537
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1538
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1539
- * `America/New_York` or `UTC`.
1540
- *
1541
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1542
- */
1543
- timeZone?: string | null;
1544
- /**
1545
- * Information about which fields containing personal data to return. Refer to the
1546
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1547
- * for more information.
1548
- *
1549
- * Supported values:
1550
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1551
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1552
- *
1553
- * Max: 1 field
1554
- * Default: No personal data is returned.
1555
- */
1556
- fields?: RequestedFields$1[];
1557
- }
1558
- declare enum RequestedFields$1 {
1559
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
1560
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
1561
- PI_FIELDS = "PI_FIELDS",
1562
- /** Returns only fields containing your own personal data. */
1563
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
1564
- }
1565
- interface GetEventResponse {
1566
- /** Retrieved event. */
1567
- event?: Event$1;
1668
+ interface MessageEnvelope$4 {
1669
+ /** App instance ID. */
1670
+ instanceId?: string | null;
1671
+ /** Event type. */
1672
+ eventType?: string;
1673
+ /** The identification type and identity data. */
1674
+ identity?: IdentificationData$4;
1675
+ /** Stringify payload. */
1676
+ data?: string;
1568
1677
  }
1569
- interface ListEventsRequest {
1570
- /**
1571
- * IDs of the events to retrieve.
1572
- *
1573
- * Min: 1 event ID
1574
- * Min: 100 event IDs
1575
- */
1576
- eventIds: string[];
1577
- /**
1578
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1579
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1580
- * `America/New_York` or `UTC`.
1581
- *
1582
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1583
- */
1584
- timeZone?: string | null;
1585
- /**
1586
- * Information about which fields containing personal data to return. Refer to the
1587
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1588
- * for more information.
1589
- *
1590
- * Supported values:
1591
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1592
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1593
- *
1594
- * Max: 1 field
1595
- * Default: No personal data is returned.
1596
- */
1597
- fields?: RequestedFields$1[];
1678
+ interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
1679
+ /** ID of a site visitor that has not logged in to the site. */
1680
+ anonymousVisitorId?: string;
1681
+ /** ID of a site visitor that has logged in to the site. */
1682
+ memberId?: string;
1683
+ /** ID of a Wix user (site owner, contributor, etc.). */
1684
+ wixUserId?: string;
1685
+ /** ID of an app. */
1686
+ appId?: string;
1687
+ /** @readonly */
1688
+ identityType?: WebhookIdentityType$4;
1598
1689
  }
1599
- interface ListEventsResponse {
1600
- /** Retrieved events matching the provided IDs. */
1601
- events?: Event$1[];
1690
+ /** @oneof */
1691
+ interface IdentificationDataIdOneOf$4 {
1692
+ /** ID of a site visitor that has not logged in to the site. */
1693
+ anonymousVisitorId?: string;
1694
+ /** ID of a site visitor that has logged in to the site. */
1695
+ memberId?: string;
1696
+ /** ID of a Wix user (site owner, contributor, etc.). */
1697
+ wixUserId?: string;
1698
+ /** ID of an app. */
1699
+ appId?: string;
1602
1700
  }
1603
- interface QueryEventsRequest {
1604
- /**
1605
- * Local start date and time from which events are returned in
1606
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1607
- * `2024-01-30T13:30:00`.
1608
- *
1609
- * Events that start before the `fromLocalDate` but end after it are included in
1610
- * the results. Must be earlier than `toLocalDate` unless the sort order is
1611
- * descending.
1612
- */
1613
- fromLocalDate?: string | null;
1701
+ declare enum WebhookIdentityType$4 {
1702
+ UNKNOWN = "UNKNOWN",
1703
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1704
+ MEMBER = "MEMBER",
1705
+ WIX_USER = "WIX_USER",
1706
+ APP = "APP"
1707
+ }
1708
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
1709
+ interface SitePropertiesNotification$2 {
1710
+ /** The site ID for which this update notification applies. */
1711
+ metasiteId?: string;
1712
+ /** The actual update event. */
1713
+ event?: SitePropertiesEvent$2;
1714
+ /** A convenience set of mappings from the MetaSite ID to its constituent services. */
1715
+ translations?: Translation$2[];
1716
+ /** Context of the notification */
1717
+ changeContext?: ChangeContext$2;
1718
+ }
1719
+ /** The actual update event for a particular notification. */
1720
+ interface SitePropertiesEvent$2 {
1721
+ /** Version of the site's properties represented by this update. */
1722
+ version?: number;
1723
+ /** Updated properties. */
1724
+ properties?: Properties$2;
1725
+ }
1726
+ interface Properties$2 {
1727
+ /** Site categories. */
1728
+ categories?: Categories$2;
1729
+ /** Site locale. */
1730
+ locale?: Locale$2;
1614
1731
  /**
1615
- * Local end date and time up to which events are returned in
1616
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1617
- * `2024-01-30T13:30:00`.
1732
+ * Site language.
1618
1733
  *
1619
- * Events that start before `toLocalDate` but end after it are included in the
1620
- * results. Must be later than `fromLocalDate` unless the sort order is
1621
- * descending.
1734
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1622
1735
  */
1623
- toLocalDate?: string | null;
1736
+ language?: string | null;
1624
1737
  /**
1625
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1626
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1627
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1738
+ * Site currency format used to bill customers.
1628
1739
  *
1629
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1740
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1630
1741
  */
1742
+ paymentCurrency?: string | null;
1743
+ /** Timezone in `America/New_York` format. */
1631
1744
  timeZone?: string | null;
1632
- /** Query containing filters and paging. */
1633
- query?: CursorQuery$2;
1634
- /**
1635
- * Filters events based on their `recurrenceType`.
1636
- *
1637
- * Max: 5 recurrence types can be specified.
1638
- * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
1639
- */
1640
- recurrenceType?: RecurrenceType$1[];
1745
+ /** Email address. */
1746
+ email?: string | null;
1747
+ /** Phone number. */
1748
+ phone?: string | null;
1749
+ /** Fax number. */
1750
+ fax?: string | null;
1751
+ /** Address. */
1752
+ address?: Address$2;
1753
+ /** Site display name. */
1754
+ siteDisplayName?: string | null;
1755
+ /** Business name. */
1756
+ businessName?: string | null;
1757
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
1758
+ logo?: string | null;
1759
+ /** Site description. */
1760
+ description?: string | null;
1641
1761
  /**
1642
- * Information about which fields containing personal data to return. Refer to the
1643
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1644
- * for more information.
1645
- *
1646
- * Supported values:
1647
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1648
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1762
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1649
1763
  *
1650
- * Max: 1 field
1651
- * Default: No personal data is returned.
1764
+ * __Note:__ Not supported by Wix Bookings.
1652
1765
  */
1653
- fields?: RequestedFields$1[];
1654
- }
1655
- /** TODO Diverge */
1656
- interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
1657
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1658
- cursorPaging?: CursorPaging$2;
1766
+ businessSchedule?: BusinessSchedule$2;
1767
+ /** Supported languages of a site and the primary language. */
1768
+ multilingual?: Multilingual$2;
1769
+ /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
1770
+ consentPolicy?: ConsentPolicy$2;
1659
1771
  /**
1660
- * Filter object.
1661
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
1662
- * for more information.
1663
- *
1664
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
1772
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1665
1773
  *
1666
- * For a detailed list of supported filters, see Supported Filters.
1667
- */
1668
- filter?: Record<string, any> | null;
1669
- /**
1670
- * Whether to sort events by their start date in ascending order or by their end date in descending order.
1671
- * Default is start ascending.
1672
- */
1673
- sort?: Sorting[];
1674
- }
1675
- /** @oneof */
1676
- interface CursorQueryPagingMethodOneOf$2 {
1677
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1678
- cursorPaging?: CursorPaging$2;
1679
- }
1680
- /** TODO Diverge */
1681
- interface Sorting {
1682
- /**
1683
- * The field to sort by.
1684
- * Either `start` or `end`.
1685
- * Default is `start`.
1774
+ * Site business type.
1686
1775
  */
1687
- fieldName?: string;
1688
- /** Sort order. */
1689
- order?: SortOrder;
1776
+ businessConfig?: string | null;
1777
+ /** External site url that uses Wix as its headless business solution */
1778
+ externalSiteUrl?: string | null;
1779
+ /** Track clicks analytics */
1780
+ trackClicksAnalytics?: boolean;
1690
1781
  }
1691
- declare enum SortOrder {
1692
- ASC = "ASC",
1693
- DESC = "DESC"
1782
+ interface Categories$2 {
1783
+ /** Primary site category. */
1784
+ primary?: string;
1785
+ /** Secondary site category. */
1786
+ secondary?: string[];
1787
+ /** Business Term Id */
1788
+ businessTermId?: string | null;
1694
1789
  }
1695
- /** TODO Diverge */
1696
- interface CursorPaging$2 {
1697
- /**
1698
- * Number of events to return.
1699
- * Defaults to `50`. Maximum `1000`.
1700
- */
1701
- limit?: number | null;
1702
- /**
1703
- * Pointer to the next or previous page in the list of results.
1704
- *
1705
- * You can get the relevant cursor token
1706
- * from the `pagingMetadata` object in the previous call's response.
1707
- * Not relevant for the first request.
1708
- */
1709
- cursor?: string | null;
1790
+ interface Locale$2 {
1791
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1792
+ languageCode?: string;
1793
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1794
+ country?: string;
1710
1795
  }
1711
- interface QueryEventsResponse {
1712
- /** Retrieved events matching the provided query. */
1713
- events?: Event$1[];
1714
- /** Paging metadata. */
1715
- pagingMetadata?: CursorPagingMetadata$2;
1796
+ interface Address$2 {
1797
+ /** Street name. */
1798
+ street?: string;
1799
+ /** City name. */
1800
+ city?: string;
1801
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1802
+ country?: string;
1803
+ /** State. */
1804
+ state?: string;
1805
+ /** Zip or postal code. */
1806
+ zip?: string;
1807
+ /** Extra information to be displayed in the address. */
1808
+ hint?: AddressHint$2;
1809
+ /** Whether this address represents a physical location. */
1810
+ isPhysical?: boolean;
1811
+ /** Google-formatted version of this address. */
1812
+ googleFormattedAddress?: string;
1813
+ /** Street number. */
1814
+ streetNumber?: string;
1815
+ /** Apartment number. */
1816
+ apartmentNumber?: string;
1817
+ /** Geographic coordinates of location. */
1818
+ coordinates?: GeoCoordinates$2;
1716
1819
  }
1717
- /** TODO Diverge */
1718
- interface CursorPagingMetadata$2 {
1719
- /** Number of items returned in the response. */
1720
- count?: number | null;
1721
- /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
1722
- cursors?: Cursors$2;
1723
- /**
1724
- * Indicates if there are more results after the current page.
1725
- * If `true`, another page of results can be retrieved.
1726
- * If `false`, this is the last page.
1727
- */
1728
- hasNext?: boolean | null;
1820
+ /**
1821
+ * Extra information on displayed addresses.
1822
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1823
+ * Free text. In addition the user can state where he wants that additional description - before, after, or instead
1824
+ * the address string.
1825
+ */
1826
+ interface AddressHint$2 {
1827
+ /** Extra text displayed next to, or instead of, the actual address. */
1828
+ text?: string;
1829
+ /** Where the extra text should be displayed. */
1830
+ placement?: PlacementType$2;
1729
1831
  }
1730
- interface Cursors$2 {
1731
- /** Cursor pointing to next page in the list of results. */
1732
- next?: string | null;
1832
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
1833
+ declare enum PlacementType$2 {
1834
+ BEFORE = "BEFORE",
1835
+ AFTER = "AFTER",
1836
+ REPLACE = "REPLACE"
1733
1837
  }
1734
- interface ListRecurringEventInstancesHistoryRequest {
1735
- /**
1736
- * The ID of the recurring event.
1737
- * Required, unless `cursorPaging` is provided.
1738
- */
1739
- recurringEventId?: string | null;
1740
- /**
1741
- * The revision of the recurring event.
1742
- * Required, unless `cursorPaging` is provided.
1743
- */
1744
- revision?: string | null;
1745
- /**
1746
- * Inclusive start date for which events are returned, in ISO-8601 format.
1747
- * Events that begin at or after the `fromDate` are included in the results.
1748
- * Required, unless `cursorPaging` is provided.
1749
- */
1750
- fromDate?: Date | null;
1751
- /**
1752
- * Exclusive end date for which events are returned, in ISO-8601 format.
1753
- * Events that begin before the `toDate` are included in the results.
1754
- * Required, unless `cursorPaging` is provided.
1755
- */
1756
- toDate?: Date | null;
1757
- /** Optional cursor pointing to the next page of events. */
1758
- cursorPaging?: CursorPaging$2;
1838
+ /** Geocoordinates for a particular address. */
1839
+ interface GeoCoordinates$2 {
1840
+ /** Latitude of the location. Must be between -90 and 90. */
1841
+ latitude?: number;
1842
+ /** Longitude of the location. Must be between -180 and 180. */
1843
+ longitude?: number;
1759
1844
  }
1760
- interface ListRecurringEventInstancesHistoryResponse {
1761
- /** The recurring event instances. */
1762
- recurringEventInstances?: Event$1[];
1763
- /** Paging metadata. */
1764
- pagingMetadata?: CursorPagingMetadata$2;
1845
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1846
+ interface BusinessSchedule$2 {
1847
+ /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
1848
+ periods?: TimePeriod$2[];
1849
+ /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
1850
+ specialHourPeriod?: SpecialHourPeriod$2[];
1765
1851
  }
1766
- interface CreateEventRequest {
1767
- /** Event to create. */
1768
- event: Event$1;
1852
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
1853
+ interface TimePeriod$2 {
1854
+ /** Day of the week the period starts on. */
1855
+ openDay?: DayOfWeek$2;
1769
1856
  /**
1770
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1771
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1772
- * `America/New_York` or `UTC`.
1773
- *
1774
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1857
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1858
+ * midnight at the end of the specified day.
1775
1859
  */
1776
- timeZone?: string | null;
1860
+ openTime?: string;
1861
+ /** Day of the week the period ends on. */
1862
+ closeDay?: DayOfWeek$2;
1777
1863
  /**
1778
- * Idempotency key guaranteeing that you don't create the same event more
1779
- * than once.
1864
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1865
+ * midnight at the end of the specified day.
1866
+ *
1867
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1780
1868
  */
1781
- idempotencyKey?: string | null;
1869
+ closeTime?: string;
1782
1870
  }
1783
- interface CreateEventResponse {
1784
- /** Created event. */
1785
- event?: Event$1;
1871
+ /** Enumerates the days of the week. */
1872
+ declare enum DayOfWeek$2 {
1873
+ MONDAY = "MONDAY",
1874
+ TUESDAY = "TUESDAY",
1875
+ WEDNESDAY = "WEDNESDAY",
1876
+ THURSDAY = "THURSDAY",
1877
+ FRIDAY = "FRIDAY",
1878
+ SATURDAY = "SATURDAY",
1879
+ SUNDAY = "SUNDAY"
1786
1880
  }
1787
- interface BulkCreateEventRequest {
1788
- /** Events to create. */
1789
- events: MaskedEvent[];
1790
- /**
1791
- * Whether to return created events.
1792
- *
1793
- * Default: `false`.
1794
- */
1795
- returnEntity?: boolean | null;
1881
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1882
+ interface SpecialHourPeriod$2 {
1883
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1884
+ startDate?: string;
1885
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1886
+ endDate?: string;
1796
1887
  /**
1797
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1798
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1799
- * `America/New_York` or `UTC`.
1888
+ * Whether the business is closed (or the service is not available) during the exception.
1800
1889
  *
1801
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1890
+ * Default: `true`.
1802
1891
  */
1803
- timeZone?: string | null;
1892
+ isClosed?: boolean;
1893
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1894
+ comment?: string;
1804
1895
  }
1805
- interface MaskedEvent {
1806
- /** Event to create. */
1807
- event?: Event$1;
1896
+ interface Multilingual$2 {
1897
+ /** Supported languages list. */
1898
+ supportedLanguages?: SupportedLanguage$2[];
1899
+ /** Whether to redirect to user language. */
1900
+ autoRedirect?: boolean;
1808
1901
  }
1809
- interface BulkCreateEventResponse {
1810
- /** The result for each event, containing the event and whether the action was successful. */
1811
- results?: BulkEventResult[];
1812
- /** Total successes and failures. */
1813
- bulkActionMetadata?: BulkActionMetadata;
1902
+ interface SupportedLanguage$2 {
1903
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1904
+ languageCode?: string;
1905
+ /** Locale. */
1906
+ locale?: Locale$2;
1907
+ /** Whether the supported language is the primary language for the site. */
1908
+ isPrimary?: boolean;
1909
+ /** Language icon. */
1910
+ countryCode?: string;
1911
+ /** How the language will be resolved. For internal use. */
1912
+ resolutionMethod?: ResolutionMethod$2;
1814
1913
  }
1815
- interface BulkEventResult {
1816
- /** Whether the requested action was successful. */
1817
- itemMetadata?: ItemMetadata;
1818
- /** The event. */
1819
- item?: Event$1;
1914
+ declare enum ResolutionMethod$2 {
1915
+ QUERY_PARAM = "QUERY_PARAM",
1916
+ SUBDOMAIN = "SUBDOMAIN",
1917
+ SUBDIRECTORY = "SUBDIRECTORY"
1820
1918
  }
1821
- interface ItemMetadata {
1822
- /**
1823
- * Event ID.
1824
- * Should always be available, unless it's impossible (for example, when failing to create an event).
1825
- */
1826
- _id?: string | null;
1827
- /** Index of the item within the request array, for correlation between request and response items. */
1828
- originalIndex?: number;
1829
- /**
1830
- * Whether the requested action was successful for this event.
1831
- * When `false`, the `error` field is populated.
1832
- */
1833
- success?: boolean;
1834
- /** Details about the error in case of failure. */
1835
- error?: ApplicationError;
1919
+ interface ConsentPolicy$2 {
1920
+ /** Whether the site uses cookies that are essential to site operation. */
1921
+ essential?: boolean | null;
1922
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
1923
+ functional?: boolean | null;
1924
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
1925
+ analytics?: boolean | null;
1926
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
1927
+ advertising?: boolean | null;
1928
+ /** CCPA compliance flag. */
1929
+ dataToThirdParty?: boolean | null;
1836
1930
  }
1837
- interface ApplicationError {
1838
- /** Error code. */
1839
- code?: string;
1840
- /** Description of the error. */
1841
- description?: string;
1842
- /** Data related to the error. */
1843
- data?: Record<string, any> | null;
1931
+ /** A single mapping from the MetaSite ID to a particular service. */
1932
+ interface Translation$2 {
1933
+ /** The service type. */
1934
+ serviceType?: string;
1935
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1936
+ appDefId?: string;
1937
+ /** The instance ID of the service. */
1938
+ instanceId?: string;
1844
1939
  }
1845
- interface BulkActionMetadata {
1846
- /** Number of events that were successfully processed. */
1847
- totalSuccesses?: number;
1848
- /** Number of events that couldn't be processed. */
1849
- totalFailures?: number;
1940
+ interface ChangeContext$2 extends ChangeContextPayloadOneOf$2 {
1941
+ /** Properties were updated. */
1942
+ propertiesChange?: PropertiesChange$2;
1943
+ /** Default properties were created on site creation. */
1944
+ siteCreated?: SiteCreated$2;
1945
+ /** Properties were cloned on site cloning. */
1946
+ siteCloned?: SiteCloned$2;
1850
1947
  }
1851
- interface UpdateEventRequest {
1852
- /** Event to update. */
1853
- event: Event$1;
1854
- /**
1855
- * Information about whether participants of the updated event are notified and
1856
- * the message they receive.
1857
- */
1858
- participantNotification?: ParticipantNotification$1;
1859
- /**
1860
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1861
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1862
- * `America/New_York` or `UTC`.
1863
- *
1864
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1865
- */
1866
- timeZone?: string | null;
1948
+ /** @oneof */
1949
+ interface ChangeContextPayloadOneOf$2 {
1950
+ /** Properties were updated. */
1951
+ propertiesChange?: PropertiesChange$2;
1952
+ /** Default properties were created on site creation. */
1953
+ siteCreated?: SiteCreated$2;
1954
+ /** Properties were cloned on site cloning. */
1955
+ siteCloned?: SiteCloned$2;
1867
1956
  }
1868
- interface ParticipantNotification$1 {
1869
- /**
1870
- * Whether to notify the participants about changes made to the schedule or event.
1871
- *
1872
- * Default: `false`
1873
- */
1874
- notifyParticipants?: boolean | null;
1875
- /**
1876
- * Message to send.
1877
- *
1878
- * Min: 1 character
1879
- * Max: 5000 characters
1880
- */
1881
- message?: string | null;
1957
+ interface PropertiesChange$2 {
1882
1958
  }
1883
- interface UpdateEventResponse {
1884
- /** Updated event. */
1885
- event?: Event$1;
1959
+ interface SiteCreated$2 {
1960
+ /** Origin template site id. */
1961
+ originTemplateId?: string | null;
1886
1962
  }
1887
- /** `PRIVATE` until we'll have standard events metadata from Infra. */
1888
- interface EventUpdatedWithMetadata {
1889
- /** The updated event. */
1890
- event?: Event$1;
1891
- /**
1892
- * Information about whether participants of the updated event are notified and
1893
- * the message they receive.
1894
- */
1895
- participantNotification?: ParticipantNotification$1;
1963
+ interface SiteCloned$2 {
1964
+ /** Origin site id. */
1965
+ originMetaSiteId?: string;
1896
1966
  }
1897
- interface BulkUpdateEventRequest {
1898
- /**
1899
- * Events to update.
1900
- *
1901
- * Min: 1 event
1902
- * Max: 50 events
1967
+ interface Empty$4 {
1968
+ }
1969
+ interface ListEventsByContactIdRequest {
1970
+ /**
1971
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1972
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1903
1973
  */
1904
- events: BulkUpdateEventRequestMaskedEvent[];
1974
+ contactId: string | null;
1905
1975
  /**
1906
- * Whether to return the updated events.
1976
+ * Local start date and time from which events are returned in
1977
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1978
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1907
1979
  *
1908
- * Default: `false`
1980
+ * Events that start before the `fromLocalDate` but end after it are included in
1981
+ * the results. Must be earlier than `toLocalDate`.
1909
1982
  */
1910
- returnEntity?: boolean | null;
1983
+ fromLocalDate?: string | null;
1911
1984
  /**
1912
- * Information about whether participants of the updated event are notified and
1913
- * the message they receive.
1985
+ * Local end date and time up to which events are returned in
1986
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1987
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1988
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1989
+ *
1990
+ * Events that start before `toLocalDate` but end after it are included in the
1991
+ * results. Must be later than `fromLocalDate`.
1914
1992
  */
1915
- participantNotification?: ParticipantNotification$1;
1993
+ toLocalDate?: string | null;
1916
1994
  /**
1917
1995
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1918
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1919
- * `America/New_York` or `UTC`.
1996
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1997
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1920
1998
  *
1921
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1999
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1922
2000
  */
1923
2001
  timeZone?: string | null;
1924
- }
1925
- interface BulkUpdateEventRequestMaskedEvent {
1926
- /** Event to update. */
1927
- event?: Event$1;
1928
- }
1929
- interface BulkUpdateEventResponse {
1930
- /** The result for each event, containing the event and whether the action was successful. */
1931
- results?: BulkEventResult[];
1932
- /** Total successes and failures. */
1933
- bulkActionMetadata?: BulkActionMetadata;
1934
- }
1935
- interface UpdateEventParticipantsRequest {
1936
2002
  /**
1937
- * ID of the event to update.
1938
- *
1939
- * Min: 36 characters
1940
- * Max: 250 characters
2003
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2004
+ * to filter events by.
1941
2005
  */
1942
- eventId?: string | null;
1943
- /** The participants to update. */
1944
- participants?: Participants$1;
1945
- }
1946
- interface UpdateEventParticipantsResponse {
1947
- /** Updated event. */
1948
- event?: Event$1;
2006
+ appId?: string | null;
2007
+ /** Cursor to retrieve the next page of the results. */
2008
+ cursorPaging?: CommonCursorPaging;
1949
2009
  }
1950
- interface RestoreEventDefaultsRequest {
1951
- /** ID of the event for which to restore default values. */
1952
- eventId: string | null;
2010
+ /** TODO Diverge */
2011
+ interface CommonCursorPaging {
1953
2012
  /**
1954
- * Fields for which to restore default values.
1955
- *
1956
- * `TIME` restores default values for `start` and `end`.
1957
- *
1958
- * Min: 1 field
2013
+ * Number of events to return.
2014
+ * Defaults to `50`. Maximum `100`.
1959
2015
  */
1960
- fields: Field$1[];
2016
+ limit?: number | null;
1961
2017
  /**
1962
- * Information about whether participants of the updated event are notified and
1963
- * the message they receive.
2018
+ * Pointer to the next or previous page in the list of results.
2019
+ *
2020
+ * You can get the relevant cursor token
2021
+ * from the `pagingMetadata` object in the previous call's response.
2022
+ * Not relevant for the first request.
1964
2023
  */
1965
- participantNotification?: ParticipantNotification$1;
2024
+ cursor?: string | null;
2025
+ }
2026
+ interface ListEventsByContactIdResponse {
2027
+ /** Retrieved events. */
2028
+ events?: Event$1[];
2029
+ /** Paging metadata. */
2030
+ pagingMetadata?: CommonCursorPagingMetadata;
2031
+ }
2032
+ /** TODO Diverge */
2033
+ interface CommonCursorPagingMetadata {
2034
+ /** Number of items returned in the response. */
2035
+ count?: number | null;
2036
+ /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
2037
+ cursors?: CommonCursors;
1966
2038
  /**
1967
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1968
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1969
- * `America/New_York` or `UTC`.
1970
- *
1971
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2039
+ * Indicates if there are more results after the current page.
2040
+ * If `true`, another page of results can be retrieved.
2041
+ * If `false`, this is the last page.
1972
2042
  */
1973
- timeZone?: string | null;
2043
+ hasNext?: boolean | null;
1974
2044
  }
1975
- interface RestoreEventDefaultsResponse {
1976
- /** Updated event. */
1977
- event?: Event$1;
2045
+ interface CommonCursors {
2046
+ /** Cursor pointing to next page in the list of results. */
2047
+ next?: string | null;
1978
2048
  }
1979
- interface SplitRecurringEventRequest {
1980
- /** ID of the `MASTER` event to split. */
1981
- recurringEventId: string | null;
2049
+ interface ListEventsByMemberIdRequest {
1982
2050
  /**
1983
- * Local date and time at which the `MASTER` event is split in
1984
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1985
- * `2025-03-11T09:00:00`.
1986
- * Must be a future date that's after the `start` date of the next `INSTANCE` or
1987
- * `EXCEPTION` event in the series. Additionally, there must be another
1988
- * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
1989
- * wouldn't affect any event without a subsequent occurrence.
2051
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2052
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2053
+ * Provide `me` to retrieve events for the currently logged-in member.
2054
+ * You must have the `Read Calendars - Including PI`
2055
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2056
+ * to retrieve events for members who aren't the currently logged in member.
1990
2057
  */
1991
- splitLocalDate: string | null;
2058
+ memberId: string | null;
1992
2059
  /**
1993
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1994
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1995
- * `America/New_York` or `UTC`.
2060
+ * Local start date and time from which events are returned in
2061
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2062
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1996
2063
  *
1997
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2064
+ * Events that start before the `fromLocalDate` but end after it are included in
2065
+ * the results. Must be earlier than `toLocalDate`.
1998
2066
  */
1999
- timeZone?: string | null;
2000
- }
2001
- interface SplitRecurringEventResponse {
2002
- /** Original `MASTER` event that was shortened. */
2003
- updatedRecurringEventEndingBeforeSplit?: Event$1;
2004
- /** New `MASTER` event starting with the first event after the split date. */
2005
- newRecurringEventStartingFromSplit?: Event$1;
2006
- }
2007
- interface RecurringEventSplit {
2008
- /** Original `MASTER` event that was shortened. */
2009
- updatedRecurringEventEndingBeforeSplit?: Event$1;
2010
- /** New `MASTER` event starting with the first event after the split date. */
2011
- newRecurringEventStartingFromSplit?: Event$1;
2012
- }
2013
- interface CancelEventRequest {
2014
- /** ID of the event to cancel. */
2015
- eventId: string | null;
2067
+ fromLocalDate?: string | null;
2016
2068
  /**
2017
- * Information about whether participants of the canceled event are notified and
2018
- * the message they receive.
2069
+ * Local end date and time up to which events are returned in
2070
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2071
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2072
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2073
+ *
2074
+ * Events that start before `toLocalDate` but end after it are included in the
2075
+ * results. Must be later than `fromLocalDate`.
2019
2076
  */
2020
- participantNotification?: ParticipantNotification$1;
2077
+ toLocalDate?: string | null;
2021
2078
  /**
2022
2079
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2023
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2024
- * `America/New_York` or `UTC`.
2080
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2081
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2025
2082
  *
2026
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2083
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2027
2084
  */
2028
2085
  timeZone?: string | null;
2029
- }
2030
- interface CancelEventResponse {
2031
- /** Canceled event. */
2032
- event?: Event$1;
2033
- }
2034
- interface EventCancelled {
2035
- /** Canceled event. */
2036
- event?: Event$1;
2037
- }
2038
- interface BulkCancelEventRequest {
2039
- /** IDs of the events to cancel. */
2040
- eventIds: string[];
2041
- /**
2042
- * Whether to return the canceled events.
2043
- *
2044
- * Default: `false`
2045
- */
2046
- returnEntity?: boolean | null;
2047
2086
  /**
2048
- * Information about whether participants of the canceled events are notified and
2049
- * the message they receive.
2087
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2088
+ * to filter events by.
2050
2089
  */
2051
- participantNotification?: ParticipantNotification$1;
2090
+ appId?: string | null;
2091
+ /** Cursor to retrieve the next page of the results. */
2092
+ cursorPaging?: CommonCursorPaging;
2052
2093
  /**
2053
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2054
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2055
- * `America/New_York` or `UTC`.
2094
+ * IDs of the events to retrieve.
2095
+ * If you provide a list of IDs, all other filters are ignored.
2056
2096
  *
2057
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2097
+ * Max: 100 `eventId`s
2058
2098
  */
2059
- timeZone?: string | null;
2060
- }
2061
- interface BulkCancelEventResponse {
2062
- /** The result for each event, containing the event and whether the action was successful. */
2063
- results?: BulkEventResult[];
2064
- /** Total successes and failures. */
2065
- bulkActionMetadata?: BulkActionMetadata;
2066
- }
2067
- interface MessageEnvelope$4 {
2068
- /** App instance ID. */
2069
- instanceId?: string | null;
2070
- /** Event type. */
2071
- eventType?: string;
2072
- /** The identification type and identity data. */
2073
- identity?: IdentificationData$4;
2074
- /** Stringify payload. */
2075
- data?: string;
2076
- }
2077
- interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
2078
- /** ID of a site visitor that has not logged in to the site. */
2079
- anonymousVisitorId?: string;
2080
- /** ID of a site visitor that has logged in to the site. */
2081
- memberId?: string;
2082
- /** ID of a Wix user (site owner, contributor, etc.). */
2083
- wixUserId?: string;
2084
- /** ID of an app. */
2085
- appId?: string;
2086
- /** @readonly */
2087
- identityType?: WebhookIdentityType$4;
2088
- }
2089
- /** @oneof */
2090
- interface IdentificationDataIdOneOf$4 {
2091
- /** ID of a site visitor that has not logged in to the site. */
2092
- anonymousVisitorId?: string;
2093
- /** ID of a site visitor that has logged in to the site. */
2094
- memberId?: string;
2095
- /** ID of a Wix user (site owner, contributor, etc.). */
2096
- wixUserId?: string;
2097
- /** ID of an app. */
2098
- appId?: string;
2099
+ eventIds?: string[];
2099
2100
  }
2100
- declare enum WebhookIdentityType$4 {
2101
- UNKNOWN = "UNKNOWN",
2102
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2103
- MEMBER = "MEMBER",
2104
- WIX_USER = "WIX_USER",
2105
- APP = "APP"
2101
+ interface ListEventsByMemberIdResponse {
2102
+ /** Retrieved events. */
2103
+ events?: Event$1[];
2104
+ /** Paging metadata. */
2105
+ pagingMetadata?: CommonCursorPagingMetadata;
2106
2106
  }
2107
2107
  interface RecurrenceRuleNonNullableFields {
2108
2108
  frequency: Frequency$1;
@@ -2141,12 +2141,6 @@ interface EventNonNullableFields {
2141
2141
  inheritedFields: Field$1[];
2142
2142
  permissions: PermissionNonNullableFields$1[];
2143
2143
  }
2144
- interface ListEventsByContactIdResponseNonNullableFields {
2145
- events: EventNonNullableFields[];
2146
- }
2147
- interface ListEventsByMemberIdResponseNonNullableFields {
2148
- events: EventNonNullableFields[];
2149
- }
2150
2144
  interface GetEventResponseNonNullableFields {
2151
2145
  event?: EventNonNullableFields;
2152
2146
  }
@@ -2201,6 +2195,12 @@ interface BulkCancelEventResponseNonNullableFields {
2201
2195
  results: BulkEventResultNonNullableFields[];
2202
2196
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2203
2197
  }
2198
+ interface ListEventsByContactIdResponseNonNullableFields {
2199
+ events: EventNonNullableFields[];
2200
+ }
2201
+ interface ListEventsByMemberIdResponseNonNullableFields {
2202
+ events: EventNonNullableFields[];
2203
+ }
2204
2204
  interface BaseEventMetadata$4 {
2205
2205
  /** App instance ID. */
2206
2206
  instanceId?: string | null;
@@ -2263,85 +2263,6 @@ interface EventUpdatedEnvelope {
2263
2263
  entity: Event$1;
2264
2264
  metadata: EventMetadata$4;
2265
2265
  }
2266
- interface ListEventsByContactIdOptions {
2267
- /**
2268
- * Local start date and time from which events are returned in
2269
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2270
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2271
- *
2272
- * Events that start before the `fromLocalDate` but end after it are included in
2273
- * the results. Must be earlier than `toLocalDate`.
2274
- */
2275
- fromLocalDate?: string | null;
2276
- /**
2277
- * Local end date and time up to which events are returned in
2278
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2279
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2280
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2281
- *
2282
- * Events that start before `toLocalDate` but end after it are included in the
2283
- * results. Must be later than `fromLocalDate`.
2284
- */
2285
- toLocalDate?: string | null;
2286
- /**
2287
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2288
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2289
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2290
- *
2291
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2292
- */
2293
- timeZone?: string | null;
2294
- /**
2295
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2296
- * to filter events by.
2297
- */
2298
- appId?: string | null;
2299
- /** Cursor to retrieve the next page of the results. */
2300
- cursorPaging?: CommonCursorPaging;
2301
- }
2302
- interface ListEventsByMemberIdOptions {
2303
- /**
2304
- * Local start date and time from which events are returned in
2305
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2306
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2307
- *
2308
- * Events that start before the `fromLocalDate` but end after it are included in
2309
- * the results. Must be earlier than `toLocalDate`.
2310
- */
2311
- fromLocalDate?: string | null;
2312
- /**
2313
- * Local end date and time up to which events are returned in
2314
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2315
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2316
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2317
- *
2318
- * Events that start before `toLocalDate` but end after it are included in the
2319
- * results. Must be later than `fromLocalDate`.
2320
- */
2321
- toLocalDate?: string | null;
2322
- /**
2323
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2324
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2325
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2326
- *
2327
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2328
- */
2329
- timeZone?: string | null;
2330
- /**
2331
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2332
- * to filter events by.
2333
- */
2334
- appId?: string | null;
2335
- /** Cursor to retrieve the next page of the results. */
2336
- cursorPaging?: CommonCursorPaging;
2337
- /**
2338
- * IDs of the events to retrieve.
2339
- * If you provide a list of IDs, all other filters are ignored.
2340
- *
2341
- * Max: 100 `eventId`s
2342
- */
2343
- eventIds?: string[];
2344
- }
2345
2266
  interface GetEventOptions {
2346
2267
  /**
2347
2268
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2439,7 +2360,7 @@ interface QueryEventsOptions {
2439
2360
  fields?: RequestedFields$1[] | undefined;
2440
2361
  }
2441
2362
  interface QueryCursorResult$2 {
2442
- cursors: CommonCursors;
2363
+ cursors: Cursors$2;
2443
2364
  hasNext: () => boolean;
2444
2365
  hasPrev: () => boolean;
2445
2366
  length: number;
@@ -2842,41 +2763,86 @@ interface BulkCancelEventOptions {
2842
2763
  */
2843
2764
  timeZone?: string | null;
2844
2765
  }
2845
-
2846
- declare function listEventsByContactId$1(httpClient: HttpClient): ListEventsByContactIdSignature;
2847
- interface ListEventsByContactIdSignature {
2766
+ interface ListEventsByContactIdOptions {
2848
2767
  /**
2849
- * Retrieves a list of events filtered by the participant's
2850
- * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
2851
- * ID.
2768
+ * Local start date and time from which events are returned in
2769
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2770
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2852
2771
  *
2772
+ * Events that start before the `fromLocalDate` but end after it are included in
2773
+ * the results. Must be earlier than `toLocalDate`.
2774
+ */
2775
+ fromLocalDate?: string | null;
2776
+ /**
2777
+ * Local end date and time up to which events are returned in
2778
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2779
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2780
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2853
2781
  *
2854
- * You can't set `toLocalDate` to a value that's more than a full year after
2855
- * `fromLocalDate`.
2856
- * @param - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2857
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2782
+ * Events that start before `toLocalDate` but end after it are included in the
2783
+ * results. Must be later than `fromLocalDate`.
2858
2784
  */
2859
- (contactId: string | null, options?: ListEventsByContactIdOptions | undefined): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
2785
+ toLocalDate?: string | null;
2786
+ /**
2787
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2788
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2789
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2790
+ *
2791
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2792
+ */
2793
+ timeZone?: string | null;
2794
+ /**
2795
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2796
+ * to filter events by.
2797
+ */
2798
+ appId?: string | null;
2799
+ /** Cursor to retrieve the next page of the results. */
2800
+ cursorPaging?: CommonCursorPaging;
2860
2801
  }
2861
- declare function listEventsByMemberId$1(httpClient: HttpClient): ListEventsByMemberIdSignature;
2862
- interface ListEventsByMemberIdSignature {
2802
+ interface ListEventsByMemberIdOptions {
2863
2803
  /**
2864
- * Retrieves a list of events filtered by the participant's
2865
- * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
2866
- * ID.
2804
+ * Local start date and time from which events are returned in
2805
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2806
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2867
2807
  *
2808
+ * Events that start before the `fromLocalDate` but end after it are included in
2809
+ * the results. Must be earlier than `toLocalDate`.
2810
+ */
2811
+ fromLocalDate?: string | null;
2812
+ /**
2813
+ * Local end date and time up to which events are returned in
2814
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2815
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2816
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2868
2817
  *
2869
- * You can't set `toLocalDate` to a value that's more than a full year after
2870
- * `fromLocalDate`.
2871
- * @param - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2872
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2873
- * Provide `me` to retrieve events for the currently logged-in member.
2874
- * You must have the `Read Calendars - Including PI`
2875
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2876
- * to retrieve events for members who aren't the currently logged in member.
2818
+ * Events that start before `toLocalDate` but end after it are included in the
2819
+ * results. Must be later than `fromLocalDate`.
2877
2820
  */
2878
- (memberId: string | null, options?: ListEventsByMemberIdOptions | undefined): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
2821
+ toLocalDate?: string | null;
2822
+ /**
2823
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2824
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2825
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2826
+ *
2827
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2828
+ */
2829
+ timeZone?: string | null;
2830
+ /**
2831
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2832
+ * to filter events by.
2833
+ */
2834
+ appId?: string | null;
2835
+ /** Cursor to retrieve the next page of the results. */
2836
+ cursorPaging?: CommonCursorPaging;
2837
+ /**
2838
+ * IDs of the events to retrieve.
2839
+ * If you provide a list of IDs, all other filters are ignored.
2840
+ *
2841
+ * Max: 100 `eventId`s
2842
+ */
2843
+ eventIds?: string[];
2879
2844
  }
2845
+
2880
2846
  declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
2881
2847
  interface GetEventSignature {
2882
2848
  /**
@@ -3075,6 +3041,40 @@ interface BulkCancelEventSignature {
3075
3041
  */
3076
3042
  (eventIds: string[], options?: BulkCancelEventOptions | undefined): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
3077
3043
  }
3044
+ declare function listEventsByContactId$1(httpClient: HttpClient): ListEventsByContactIdSignature;
3045
+ interface ListEventsByContactIdSignature {
3046
+ /**
3047
+ * Retrieves a list of events filtered by the participant's
3048
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
3049
+ * ID.
3050
+ *
3051
+ *
3052
+ * You can't set `toLocalDate` to a value that's more than a full year after
3053
+ * `fromLocalDate`.
3054
+ * @param - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
3055
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
3056
+ */
3057
+ (contactId: string | null, options?: ListEventsByContactIdOptions | undefined): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
3058
+ }
3059
+ declare function listEventsByMemberId$1(httpClient: HttpClient): ListEventsByMemberIdSignature;
3060
+ interface ListEventsByMemberIdSignature {
3061
+ /**
3062
+ * Retrieves a list of events filtered by the participant's
3063
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
3064
+ * ID.
3065
+ *
3066
+ *
3067
+ * You can't set `toLocalDate` to a value that's more than a full year after
3068
+ * `fromLocalDate`.
3069
+ * @param - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
3070
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
3071
+ * Provide `me` to retrieve events for the currently logged-in member.
3072
+ * You must have the `Read Calendars - Including PI`
3073
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
3074
+ * to retrieve events for members who aren't the currently logged in member.
3075
+ */
3076
+ (memberId: string | null, options?: ListEventsByMemberIdOptions | undefined): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
3077
+ }
3078
3078
  declare const onEventCancelled$1: EventDefinition<EventCancelledEnvelope, "wix.calendar.v3.event_cancelled">;
3079
3079
  declare const onEventCreated$1: EventDefinition<EventCreatedEnvelope, "wix.calendar.v3.event_created">;
3080
3080
  declare const onEventRecurringSplit$1: EventDefinition<EventRecurringSplitEnvelope, "wix.calendar.v3.event_recurring_split">;
@@ -3082,8 +3082,6 @@ declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.calen
3082
3082
 
3083
3083
  declare function createEventModule$4<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3084
3084
 
3085
- declare const listEventsByContactId: MaybeContext<BuildRESTFunction<typeof listEventsByContactId$1> & typeof listEventsByContactId$1>;
3086
- declare const listEventsByMemberId: MaybeContext<BuildRESTFunction<typeof listEventsByMemberId$1> & typeof listEventsByMemberId$1>;
3087
3085
  declare const getEvent: MaybeContext<BuildRESTFunction<typeof getEvent$1> & typeof getEvent$1>;
3088
3086
  declare const listEvents: MaybeContext<BuildRESTFunction<typeof listEvents$1> & typeof listEvents$1>;
3089
3087
  declare const queryEvents: MaybeContext<BuildRESTFunction<typeof queryEvents$1> & typeof queryEvents$1>;
@@ -3095,6 +3093,8 @@ declare const restoreEventDefaults: MaybeContext<BuildRESTFunction<typeof restor
3095
3093
  declare const splitRecurringEvent: MaybeContext<BuildRESTFunction<typeof splitRecurringEvent$1> & typeof splitRecurringEvent$1>;
3096
3094
  declare const cancelEvent: MaybeContext<BuildRESTFunction<typeof cancelEvent$1> & typeof cancelEvent$1>;
3097
3095
  declare const bulkCancelEvent: MaybeContext<BuildRESTFunction<typeof bulkCancelEvent$1> & typeof bulkCancelEvent$1>;
3096
+ declare const listEventsByContactId: MaybeContext<BuildRESTFunction<typeof listEventsByContactId$1> & typeof listEventsByContactId$1>;
3097
+ declare const listEventsByMemberId: MaybeContext<BuildRESTFunction<typeof listEventsByMemberId$1> & typeof listEventsByMemberId$1>;
3098
3098
 
3099
3099
  type _publicOnEventCancelledType = typeof onEventCancelled$1;
3100
3100
  /**
@@ -4255,8 +4255,8 @@ interface Participant {
4255
4255
  /** Participant's email address. */
4256
4256
  email?: string | null;
4257
4257
  /**
4258
- * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
4259
- * ID of the parcipant.
4258
+ * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
4259
+ * ID of the participant.
4260
4260
  */
4261
4261
  contactId?: string | null;
4262
4262
  }
@@ -4566,13 +4566,13 @@ interface ParticipationCreatedEnvelope {
4566
4566
  entity: Participation;
4567
4567
  metadata: EventMetadata$2;
4568
4568
  }
4569
- interface ParticipationDeletedEnvelope {
4570
- metadata: EventMetadata$2;
4571
- }
4572
4569
  interface ParticipationUpdatedEnvelope {
4573
4570
  entity: Participation;
4574
4571
  metadata: EventMetadata$2;
4575
4572
  }
4573
+ interface ParticipationDeletedEnvelope {
4574
+ metadata: EventMetadata$2;
4575
+ }
4576
4576
  interface QueryCursorResult$1 {
4577
4577
  cursors: Cursors$1;
4578
4578
  hasNext: () => boolean;
@@ -4692,20 +4692,23 @@ interface GetParticipationSignature {
4692
4692
  declare function queryParticipations$1(httpClient: HttpClient): QueryParticipationsSignature;
4693
4693
  interface QueryParticipationsSignature {
4694
4694
  /**
4695
- * Retrieves a list of `participations`, given the provided paging, filtering, and sorting.
4695
+ * Creates a query to retrieve a list of participations.
4696
+ *
4697
+ * The `queryParticipations()` function builds a query to retrieve a list of participations and returns a `ParticipationsQueryBuilder` object.
4698
+ *
4699
+ * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/participations/participations-query-builder/find) function.
4700
+ *
4701
+ * You can refine the query by chaining `ParticipationsQueryBuilder` functions onto the query. `ParticipationsQueryBuilder` functions enable you to sort, filter, and control the results that `queryParticipations()` returns.
4696
4702
  *
4703
+ * `queryParticipations()` runs with the following `ParticipationsQueryBuilder` default that you can override:
4697
4704
  *
4698
- * Query Participations runs with these defaults, which you can override:
4699
- * - `createdDate` is sorted in `DESC` order
4700
- * - `cursorPaging.limit` is `50`
4705
+ * + `limit` is `50`.
4706
+ * + Sorted by `createdDate` in ascending order.
4707
+ *
4708
+ * The functions that are chained to `queryParticipations()` are applied in the order they are called.
4701
4709
  *
4702
- * For field support for filters and sorting,
4703
- * see [Calendar Participations V3: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/calendar/participations-v3/supported-filters-and-sorting).
4710
+ * The following `ParticipationsQueryBuilder` functions are supported for the `queryParticipations()` function. For a full description of the participations object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/participations/participations-query-result/items) property in `ParticipationsQueryResult`.
4704
4711
  *
4705
- * To learn about working with _Query_ endpoints, see
4706
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
4707
- * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),
4708
- * and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection).
4709
4712
  */
4710
4713
  (): ParticipationsQueryBuilder;
4711
4714
  }
@@ -4736,8 +4739,8 @@ interface DeleteParticipationSignature {
4736
4739
  (participationId: string | null): Promise<void>;
4737
4740
  }
4738
4741
  declare const onParticipationCreated$1: EventDefinition<ParticipationCreatedEnvelope, "wix.calendar.v3.participation_created">;
4739
- declare const onParticipationDeleted$1: EventDefinition<ParticipationDeletedEnvelope, "wix.calendar.v3.participation_deleted">;
4740
4742
  declare const onParticipationUpdated$1: EventDefinition<ParticipationUpdatedEnvelope, "wix.calendar.v3.participation_updated">;
4743
+ declare const onParticipationDeleted$1: EventDefinition<ParticipationDeletedEnvelope, "wix.calendar.v3.participation_deleted">;
4741
4744
 
4742
4745
  declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
4743
4746
 
@@ -4753,18 +4756,18 @@ type _publicOnParticipationCreatedType = typeof onParticipationCreated$1;
4753
4756
  */
4754
4757
  declare const onParticipationCreated: ReturnType<typeof createEventModule$2<_publicOnParticipationCreatedType>>;
4755
4758
 
4756
- type _publicOnParticipationDeletedType = typeof onParticipationDeleted$1;
4757
- /**
4758
- * Triggered when a `participation` object is deleted.
4759
- */
4760
- declare const onParticipationDeleted: ReturnType<typeof createEventModule$2<_publicOnParticipationDeletedType>>;
4761
-
4762
4759
  type _publicOnParticipationUpdatedType = typeof onParticipationUpdated$1;
4763
4760
  /**
4764
4761
  * Triggered when a `participation` object is updated.
4765
4762
  */
4766
4763
  declare const onParticipationUpdated: ReturnType<typeof createEventModule$2<_publicOnParticipationUpdatedType>>;
4767
4764
 
4765
+ type _publicOnParticipationDeletedType = typeof onParticipationDeleted$1;
4766
+ /**
4767
+ * Triggered when a `participation` object is deleted.
4768
+ */
4769
+ declare const onParticipationDeleted: ReturnType<typeof createEventModule$2<_publicOnParticipationDeletedType>>;
4770
+
4768
4771
  type context$2_CreateParticipationOptions = CreateParticipationOptions;
4769
4772
  type context$2_CreateParticipationRequest = CreateParticipationRequest;
4770
4773
  type context$2_CreateParticipationResponse = CreateParticipationResponse;