@wix/bookings 1.0.499 → 1.0.500
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +8 -8
- package/type-bundles/context.bundle.d.ts +106 -128
- package/type-bundles/index.bundle.d.ts +106 -128
- package/type-bundles/meta.bundle.d.ts +44 -202
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/bookings",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.500",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -21,23 +21,23 @@
|
|
|
21
21
|
"type-bundles"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@wix/bookings_attendance": "1.0.
|
|
24
|
+
"@wix/bookings_attendance": "1.0.58",
|
|
25
25
|
"@wix/bookings_availability-calendar": "1.0.46",
|
|
26
26
|
"@wix/bookings_availability-time-slots": "1.0.37",
|
|
27
27
|
"@wix/bookings_booking-fees": "1.0.11",
|
|
28
28
|
"@wix/bookings_booking-policies": "1.0.9",
|
|
29
29
|
"@wix/bookings_booking-policy-snapshots": "1.0.7",
|
|
30
|
-
"@wix/bookings_bookings": "1.0.
|
|
30
|
+
"@wix/bookings_bookings": "1.0.72",
|
|
31
31
|
"@wix/bookings_categories": "1.0.44",
|
|
32
|
-
"@wix/bookings_extended-bookings": "1.0.
|
|
32
|
+
"@wix/bookings_extended-bookings": "1.0.60",
|
|
33
33
|
"@wix/bookings_external-calendars": "1.0.41",
|
|
34
34
|
"@wix/bookings_multi-service-availability-time-slots": "1.0.36",
|
|
35
|
-
"@wix/bookings_pricing": "1.0.
|
|
35
|
+
"@wix/bookings_pricing": "1.0.47",
|
|
36
36
|
"@wix/bookings_resource-types": "1.0.15",
|
|
37
37
|
"@wix/bookings_resources": "1.0.56",
|
|
38
38
|
"@wix/bookings_service-categories": "1.0.0",
|
|
39
|
-
"@wix/bookings_service-options-and-variants": "1.0.
|
|
40
|
-
"@wix/bookings_services": "1.0.
|
|
39
|
+
"@wix/bookings_service-options-and-variants": "1.0.57",
|
|
40
|
+
"@wix/bookings_services": "1.0.81",
|
|
41
41
|
"@wix/bookings_staff-members": "1.0.17"
|
|
42
42
|
},
|
|
43
43
|
"devDependencies": {
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"fqdn": ""
|
|
64
64
|
}
|
|
65
65
|
},
|
|
66
|
-
"falconPackageHash": "
|
|
66
|
+
"falconPackageHash": "cf46d18004d8f6969db3117993dd2284a7e69d0664ffa5b041df88ca"
|
|
67
67
|
}
|
|
@@ -5138,7 +5138,6 @@ interface ServiceOptionsAndVariants {
|
|
|
5138
5138
|
interface ServiceOption extends ServiceOptionOptionSpecificDataOneOf {
|
|
5139
5139
|
/** Details about the custom option. Available only for `CUSTOM` options. */
|
|
5140
5140
|
customData?: CustomServiceOption;
|
|
5141
|
-
durationData?: DurationServiceOption;
|
|
5142
5141
|
/** ID of the service option. */
|
|
5143
5142
|
_id?: string;
|
|
5144
5143
|
/** Type of the service option. */
|
|
@@ -5148,7 +5147,6 @@ interface ServiceOption extends ServiceOptionOptionSpecificDataOneOf {
|
|
|
5148
5147
|
interface ServiceOptionOptionSpecificDataOneOf {
|
|
5149
5148
|
/** Details about the custom option. Available only for `CUSTOM` options. */
|
|
5150
5149
|
customData?: CustomServiceOption;
|
|
5151
|
-
durationData?: DurationServiceOption;
|
|
5152
5150
|
}
|
|
5153
5151
|
declare enum ServiceOptionType {
|
|
5154
5152
|
UNKNOWN = "UNKNOWN",
|
|
@@ -5198,8 +5196,6 @@ interface ServiceChoice$3 extends ServiceChoiceChoiceOneOf$3 {
|
|
|
5198
5196
|
* `availability.linkedSchedules`.
|
|
5199
5197
|
*/
|
|
5200
5198
|
staffMemberId?: string;
|
|
5201
|
-
/** Duration and an optional name */
|
|
5202
|
-
duration?: Duration$4;
|
|
5203
5199
|
/** ID of the service option. */
|
|
5204
5200
|
optionId?: string;
|
|
5205
5201
|
}
|
|
@@ -5214,8 +5210,6 @@ interface ServiceChoiceChoiceOneOf$3 {
|
|
|
5214
5210
|
* `availability.linkedSchedules`.
|
|
5215
5211
|
*/
|
|
5216
5212
|
staffMemberId?: string;
|
|
5217
|
-
/** Duration and an optional name */
|
|
5218
|
-
duration?: Duration$4;
|
|
5219
5213
|
}
|
|
5220
5214
|
interface Duration$4 {
|
|
5221
5215
|
/**
|
|
@@ -6863,11 +6857,11 @@ interface ServiceOptionsAndVariantsCreatedEnvelope {
|
|
|
6863
6857
|
entity: ServiceOptionsAndVariants;
|
|
6864
6858
|
metadata: EventMetadata$7;
|
|
6865
6859
|
}
|
|
6866
|
-
interface
|
|
6860
|
+
interface ServiceOptionsAndVariantsDeletedEnvelope {
|
|
6867
6861
|
entity: ServiceOptionsAndVariants;
|
|
6868
6862
|
metadata: EventMetadata$7;
|
|
6869
6863
|
}
|
|
6870
|
-
interface
|
|
6864
|
+
interface ServiceOptionsAndVariantsUpdatedEnvelope {
|
|
6871
6865
|
entity: ServiceOptionsAndVariants;
|
|
6872
6866
|
metadata: EventMetadata$7;
|
|
6873
6867
|
}
|
|
@@ -7083,8 +7077,8 @@ interface QueryServiceOptionsAndVariantsSignature {
|
|
|
7083
7077
|
(): ServiceOptionsAndVariantsListQueryBuilder;
|
|
7084
7078
|
}
|
|
7085
7079
|
declare const onServiceOptionsAndVariantsCreated$1: EventDefinition<ServiceOptionsAndVariantsCreatedEnvelope, "wix.bookings.catalog.v1.service_options_and_variants_created">;
|
|
7086
|
-
declare const onServiceOptionsAndVariantsUpdated$1: EventDefinition<ServiceOptionsAndVariantsUpdatedEnvelope, "wix.bookings.catalog.v1.service_options_and_variants_updated">;
|
|
7087
7080
|
declare const onServiceOptionsAndVariantsDeleted$1: EventDefinition<ServiceOptionsAndVariantsDeletedEnvelope, "wix.bookings.catalog.v1.service_options_and_variants_deleted">;
|
|
7081
|
+
declare const onServiceOptionsAndVariantsUpdated$1: EventDefinition<ServiceOptionsAndVariantsUpdatedEnvelope, "wix.bookings.catalog.v1.service_options_and_variants_updated">;
|
|
7088
7082
|
|
|
7089
7083
|
declare function createEventModule$8<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
7090
7084
|
|
|
@@ -7100,14 +7094,14 @@ type _publicOnServiceOptionsAndVariantsCreatedType = typeof onServiceOptionsAndV
|
|
|
7100
7094
|
/** */
|
|
7101
7095
|
declare const onServiceOptionsAndVariantsCreated: ReturnType<typeof createEventModule$8<_publicOnServiceOptionsAndVariantsCreatedType>>;
|
|
7102
7096
|
|
|
7103
|
-
type _publicOnServiceOptionsAndVariantsUpdatedType = typeof onServiceOptionsAndVariantsUpdated$1;
|
|
7104
|
-
/** */
|
|
7105
|
-
declare const onServiceOptionsAndVariantsUpdated: ReturnType<typeof createEventModule$8<_publicOnServiceOptionsAndVariantsUpdatedType>>;
|
|
7106
|
-
|
|
7107
7097
|
type _publicOnServiceOptionsAndVariantsDeletedType = typeof onServiceOptionsAndVariantsDeleted$1;
|
|
7108
7098
|
/** */
|
|
7109
7099
|
declare const onServiceOptionsAndVariantsDeleted: ReturnType<typeof createEventModule$8<_publicOnServiceOptionsAndVariantsDeletedType>>;
|
|
7110
7100
|
|
|
7101
|
+
type _publicOnServiceOptionsAndVariantsUpdatedType = typeof onServiceOptionsAndVariantsUpdated$1;
|
|
7102
|
+
/** */
|
|
7103
|
+
declare const onServiceOptionsAndVariantsUpdated: ReturnType<typeof createEventModule$8<_publicOnServiceOptionsAndVariantsUpdatedType>>;
|
|
7104
|
+
|
|
7111
7105
|
type context$d_CloneServiceOptionsAndVariantsRequest = CloneServiceOptionsAndVariantsRequest;
|
|
7112
7106
|
type context$d_CloneServiceOptionsAndVariantsResponse = CloneServiceOptionsAndVariantsResponse;
|
|
7113
7107
|
type context$d_CloneServiceOptionsAndVariantsResponseNonNullableFields = CloneServiceOptionsAndVariantsResponseNonNullableFields;
|
|
@@ -9222,7 +9216,6 @@ interface ServiceChoice$2 extends ServiceChoiceChoiceOneOf$2 {
|
|
|
9222
9216
|
* Each choice may have a different price.
|
|
9223
9217
|
*/
|
|
9224
9218
|
custom?: string;
|
|
9225
|
-
duration?: Duration$3;
|
|
9226
9219
|
/**
|
|
9227
9220
|
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
9228
9221
|
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
@@ -9239,7 +9232,6 @@ interface ServiceChoiceChoiceOneOf$2 {
|
|
|
9239
9232
|
* Each choice may have a different price.
|
|
9240
9233
|
*/
|
|
9241
9234
|
custom?: string;
|
|
9242
|
-
duration?: Duration$3;
|
|
9243
9235
|
}
|
|
9244
9236
|
interface Duration$3 {
|
|
9245
9237
|
/**
|
|
@@ -12770,16 +12762,6 @@ interface V2Schedule {
|
|
|
12770
12762
|
availabilityConstraints?: V2AvailabilityConstraints;
|
|
12771
12763
|
}
|
|
12772
12764
|
interface V2AvailabilityConstraints {
|
|
12773
|
-
/**
|
|
12774
|
-
* A calculated list of all available durations for a service.
|
|
12775
|
-
*
|
|
12776
|
-
* If the service payment is of typed `Varied` with `Duration` option, this list will contain the durations of the variants.
|
|
12777
|
-
* The durations order will reflect the order of the variants.
|
|
12778
|
-
*
|
|
12779
|
-
* For any other type of service or payment this list will mirror the durations specified in `session_durations`.
|
|
12780
|
-
* @readonly
|
|
12781
|
-
*/
|
|
12782
|
-
durations?: Duration$2[];
|
|
12783
12765
|
/**
|
|
12784
12766
|
* A list of durations for sessions, in minutes.
|
|
12785
12767
|
*
|
|
@@ -15947,11 +15929,11 @@ interface ServiceCreatedEnvelope {
|
|
|
15947
15929
|
entity: Service;
|
|
15948
15930
|
metadata: EventMetadata$3;
|
|
15949
15931
|
}
|
|
15950
|
-
interface
|
|
15932
|
+
interface ServiceDeletedEnvelope {
|
|
15951
15933
|
entity: Service;
|
|
15952
15934
|
metadata: EventMetadata$3;
|
|
15953
15935
|
}
|
|
15954
|
-
interface
|
|
15936
|
+
interface ServiceUpdatedEnvelope {
|
|
15955
15937
|
entity: Service;
|
|
15956
15938
|
metadata: EventMetadata$3;
|
|
15957
15939
|
}
|
|
@@ -16427,8 +16409,8 @@ interface CloneServiceSignature {
|
|
|
16427
16409
|
(sourceServiceId: string, options?: CloneServiceOptions | undefined): Promise<CloneServiceResponse & CloneServiceResponseNonNullableFields>;
|
|
16428
16410
|
}
|
|
16429
16411
|
declare const onServiceCreated$1: EventDefinition<ServiceCreatedEnvelope, "wix.bookings.services.v2.service_created">;
|
|
16430
|
-
declare const onServiceUpdated$1: EventDefinition<ServiceUpdatedEnvelope, "wix.bookings.services.v2.service_updated">;
|
|
16431
16412
|
declare const onServiceDeleted$1: EventDefinition<ServiceDeletedEnvelope, "wix.bookings.services.v2.service_deleted">;
|
|
16413
|
+
declare const onServiceUpdated$1: EventDefinition<ServiceUpdatedEnvelope, "wix.bookings.services.v2.service_updated">;
|
|
16432
16414
|
|
|
16433
16415
|
declare function createEventModule$4<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
16434
16416
|
|
|
@@ -16457,14 +16439,14 @@ type _publicOnServiceCreatedType = typeof onServiceCreated$1;
|
|
|
16457
16439
|
/** */
|
|
16458
16440
|
declare const onServiceCreated: ReturnType<typeof createEventModule$4<_publicOnServiceCreatedType>>;
|
|
16459
16441
|
|
|
16460
|
-
type _publicOnServiceUpdatedType = typeof onServiceUpdated$1;
|
|
16461
|
-
/** */
|
|
16462
|
-
declare const onServiceUpdated: ReturnType<typeof createEventModule$4<_publicOnServiceUpdatedType>>;
|
|
16463
|
-
|
|
16464
16442
|
type _publicOnServiceDeletedType = typeof onServiceDeleted$1;
|
|
16465
16443
|
/** */
|
|
16466
16444
|
declare const onServiceDeleted: ReturnType<typeof createEventModule$4<_publicOnServiceDeletedType>>;
|
|
16467
16445
|
|
|
16446
|
+
type _publicOnServiceUpdatedType = typeof onServiceUpdated$1;
|
|
16447
|
+
/** */
|
|
16448
|
+
declare const onServiceUpdated: ReturnType<typeof createEventModule$4<_publicOnServiceUpdatedType>>;
|
|
16449
|
+
|
|
16468
16450
|
type context$6_Action = Action;
|
|
16469
16451
|
declare const context$6_Action: typeof Action;
|
|
16470
16452
|
type context$6_Aggregation = Aggregation;
|
|
@@ -21145,20 +21127,20 @@ declare namespace context$3 {
|
|
|
21145
21127
|
}
|
|
21146
21128
|
|
|
21147
21129
|
/**
|
|
21148
|
-
* The `
|
|
21130
|
+
* The `attendance` object represents the attendance information
|
|
21149
21131
|
* for a booked session, such as:
|
|
21150
21132
|
*
|
|
21151
21133
|
* + Did anyone attend the session?
|
|
21152
21134
|
* + How many people attended the session?
|
|
21153
21135
|
*
|
|
21154
|
-
* The number of session `
|
|
21155
|
-
* + Appointment bookings have 1 `
|
|
21156
|
-
* + Class bookings have 1 `
|
|
21157
|
-
* + Course bookings have an `
|
|
21136
|
+
* The number of session `attendance` objects available depends on the booking type:
|
|
21137
|
+
* + Appointment bookings have 1 `attendance` object per appointment session.
|
|
21138
|
+
* + Class bookings have 1 `attendance` object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions `schedule.capacity` property.
|
|
21139
|
+
* + Course bookings have an `attendance` object for each session of the course. For example, if there are 12 sessions in a course, there are 12 `attendance` objects. The number of sessions for a class is defined in Schedule and Sessions `schedule.capacity` property.
|
|
21158
21140
|
*/
|
|
21159
21141
|
interface Attendance {
|
|
21160
21142
|
/**
|
|
21161
|
-
* ID of the `
|
|
21143
|
+
* ID of the `attendance` object.
|
|
21162
21144
|
* @readonly
|
|
21163
21145
|
*/
|
|
21164
21146
|
_id?: string | null;
|
|
@@ -21188,30 +21170,31 @@ declare enum AttendanceStatus {
|
|
|
21188
21170
|
NOT_ATTENDED = "NOT_ATTENDED"
|
|
21189
21171
|
}
|
|
21190
21172
|
interface GetAttendanceRequest {
|
|
21191
|
-
/** ID of the
|
|
21173
|
+
/** ID of the attendance object to retrieve. */
|
|
21192
21174
|
attendanceId: string;
|
|
21193
21175
|
}
|
|
21194
21176
|
interface GetAttendanceResponse {
|
|
21195
|
-
/**
|
|
21177
|
+
/** Retrieved attendance. */
|
|
21196
21178
|
attendance?: Attendance;
|
|
21197
21179
|
}
|
|
21198
21180
|
interface SetAttendanceRequest {
|
|
21199
|
-
/**
|
|
21181
|
+
/** Attendance to create or update. */
|
|
21200
21182
|
attendance: Attendance;
|
|
21201
21183
|
/** Information about whether to send a message to a customer after their attendance was set. */
|
|
21202
21184
|
participantNotification?: ParticipantNotification$2;
|
|
21203
21185
|
}
|
|
21204
21186
|
interface ParticipantNotification$2 {
|
|
21205
21187
|
/**
|
|
21206
|
-
*
|
|
21207
|
-
*
|
|
21188
|
+
* Specify whether to send the message about the changes to the customer.
|
|
21189
|
+
*
|
|
21190
|
+
* Default: `false`
|
|
21208
21191
|
*/
|
|
21209
21192
|
notifyParticipants?: boolean | null;
|
|
21210
21193
|
/** Optional custom message to send to the participants about the changes to the booking. */
|
|
21211
21194
|
message?: string | null;
|
|
21212
21195
|
}
|
|
21213
21196
|
interface SetAttendanceResponse {
|
|
21214
|
-
/**
|
|
21197
|
+
/** Created or updated attendance. */
|
|
21215
21198
|
attendance?: Attendance;
|
|
21216
21199
|
}
|
|
21217
21200
|
interface AttendanceMarkedAsNotAttended {
|
|
@@ -21222,23 +21205,25 @@ interface AttendanceMarkedAsNotAttended {
|
|
|
21222
21205
|
}
|
|
21223
21206
|
interface BulkSetAttendanceRequest {
|
|
21224
21207
|
returnFullEntity?: boolean;
|
|
21225
|
-
/**
|
|
21208
|
+
/** List of attendance details for booking sessions to create or update. */
|
|
21226
21209
|
attendanceDetails?: AttendanceDetails[];
|
|
21227
21210
|
}
|
|
21228
21211
|
interface AttendanceDetails {
|
|
21229
|
-
/**
|
|
21212
|
+
/** Created or updated attendance information for a booking session. */
|
|
21230
21213
|
attendance?: Attendance;
|
|
21231
|
-
/** Information about whether to send a message to
|
|
21214
|
+
/** Information about whether to send a message to the customer after their attendance was set. */
|
|
21232
21215
|
participantNotification?: ParticipantNotification$2;
|
|
21233
21216
|
}
|
|
21234
21217
|
interface BulkSetAttendanceResponse {
|
|
21235
|
-
/**
|
|
21218
|
+
/** List of created or updated `attendance` objects. */
|
|
21236
21219
|
results?: BulkAttendanceResult[];
|
|
21237
|
-
/**
|
|
21220
|
+
/** Information about the total number of successes and failures for the Bulk Set Attendance call. */
|
|
21238
21221
|
bulkActionMetadata?: BulkActionMetadata$1;
|
|
21239
21222
|
}
|
|
21240
21223
|
interface BulkAttendanceResult {
|
|
21224
|
+
/** Created or updated `attendance` object. */
|
|
21241
21225
|
item?: Attendance;
|
|
21226
|
+
/** Metadata for the created or updated `attendance` object. */
|
|
21242
21227
|
itemMetadata?: ItemMetadata$1;
|
|
21243
21228
|
}
|
|
21244
21229
|
interface ItemMetadata$1 {
|
|
@@ -21336,9 +21321,9 @@ interface CursorPaging$1 {
|
|
|
21336
21321
|
}
|
|
21337
21322
|
/** List of objects that contain attendance information. */
|
|
21338
21323
|
interface QueryAttendanceResponse {
|
|
21339
|
-
/** List of objects that contain attendance information for a booked session. */
|
|
21324
|
+
/** List of `attendance` objects that contain attendance information for a booked session. */
|
|
21340
21325
|
attendances?: Attendance[];
|
|
21341
|
-
/**
|
|
21326
|
+
/** Metadata for the paged set of results. */
|
|
21342
21327
|
pagingMetadata?: CursorPagingMetadata;
|
|
21343
21328
|
}
|
|
21344
21329
|
/** This is the preferred message for cursor-paging enabled services */
|
|
@@ -21513,7 +21498,7 @@ interface SetAttendanceOptions {
|
|
|
21513
21498
|
}
|
|
21514
21499
|
interface BulkSetAttendanceOptions {
|
|
21515
21500
|
returnFullEntity?: boolean;
|
|
21516
|
-
/**
|
|
21501
|
+
/** List of attendance details for booking sessions to create or update. */
|
|
21517
21502
|
attendanceDetails?: AttendanceDetails[];
|
|
21518
21503
|
}
|
|
21519
21504
|
interface QueryCursorResult {
|
|
@@ -21585,79 +21570,76 @@ interface AttendancesQueryBuilder {
|
|
|
21585
21570
|
declare function getAttendance$1(httpClient: HttpClient): GetAttendanceSignature;
|
|
21586
21571
|
interface GetAttendanceSignature {
|
|
21587
21572
|
/**
|
|
21588
|
-
* Retrieves attendance information
|
|
21589
|
-
* @param - ID of the
|
|
21590
|
-
* @returns
|
|
21573
|
+
* Retrieves attendance information.
|
|
21574
|
+
* @param - ID of the attendance object to retrieve.
|
|
21575
|
+
* @returns Retrieved attendance.
|
|
21591
21576
|
*/
|
|
21592
21577
|
(attendanceId: string): Promise<Attendance & AttendanceNonNullableFields>;
|
|
21593
21578
|
}
|
|
21594
21579
|
declare function setAttendance$1(httpClient: HttpClient): SetAttendanceSignature;
|
|
21595
21580
|
interface SetAttendanceSignature {
|
|
21596
21581
|
/**
|
|
21597
|
-
* Sets information
|
|
21598
|
-
* is
|
|
21582
|
+
* Sets or updates attendance information for a booking session. This
|
|
21583
|
+
* information is stored in an `attendance` object.
|
|
21599
21584
|
*
|
|
21585
|
+
* If an `attendance` object already exists for the session, it's updated.
|
|
21586
|
+
* Otherwise, a new object is created.
|
|
21600
21587
|
*
|
|
21601
|
-
*
|
|
21602
|
-
*
|
|
21603
|
-
*
|
|
21588
|
+
* By default, `numberOfAttendees` is set to `1`, but you can specify a higher
|
|
21589
|
+
* number if multiple participants attended. Do not set `numberOfAttendees` to
|
|
21590
|
+
* `0` to indicate no attendance, instead specify `{"status": "NOT_ATTENDED"}`.
|
|
21604
21591
|
*
|
|
21605
|
-
*
|
|
21606
|
-
* of attendees is set to `1`, but you can set a number to greater than `1` if multiple
|
|
21607
|
-
* participants attended. Do not set to `0` to indicate that no one attended the session.
|
|
21608
|
-
* Instead, set the `status` field to `NOT_ATTENDED`.
|
|
21592
|
+
* Validation guidelines:
|
|
21609
21593
|
*
|
|
21610
|
-
*
|
|
21611
|
-
*
|
|
21612
|
-
*
|
|
21613
|
-
*
|
|
21594
|
+
* + The call succeeds for mismatches between `numberOfAttendees`
|
|
21595
|
+
* and `status`. For example, make sure that your code doesn't specify
|
|
21596
|
+
* `{"status": "NOT_ATTENDED"}` with `{"numberOfAttendees": 5}`.
|
|
21597
|
+
* + The API also allows `numberOfAttendees` to exceed the booking's
|
|
21598
|
+
* `numberOfParticipants`. Use higher values only when scenarios like
|
|
21599
|
+
* walk-ins justify the exception.
|
|
21600
|
+
* @param - Attendance to create or update.
|
|
21601
|
+
* @param - Options to use when setting an attendance.
|
|
21614
21602
|
*/
|
|
21615
21603
|
(attendance: Attendance, options?: SetAttendanceOptions | undefined): Promise<SetAttendanceResponse & SetAttendanceResponseNonNullableFields>;
|
|
21616
21604
|
}
|
|
21617
21605
|
declare function bulkSetAttendance$1(httpClient: HttpClient): BulkSetAttendanceSignature;
|
|
21618
21606
|
interface BulkSetAttendanceSignature {
|
|
21619
21607
|
/**
|
|
21620
|
-
* Sets
|
|
21608
|
+
* Sets or updates attendance information for multiple booking sessions.
|
|
21609
|
+
*
|
|
21621
21610
|
*
|
|
21611
|
+
* Refer to Set Attendance for detailed behavior of individual attendance
|
|
21612
|
+
* entries.
|
|
21622
21613
|
*
|
|
21623
|
-
*
|
|
21614
|
+
* The call fails entirely if any entry in `attendanceDetails` is missing a
|
|
21615
|
+
* required field.
|
|
21624
21616
|
*
|
|
21625
|
-
* If
|
|
21626
|
-
*
|
|
21617
|
+
* If attendance details are provided for a non-existent session, the call
|
|
21618
|
+
* succeeds for valid sessions while marking the unavailable session as a
|
|
21619
|
+
* failure in the response.
|
|
21620
|
+
* @param - Options to use when setting multiple attendances in bulk.
|
|
21627
21621
|
*/
|
|
21628
21622
|
(options?: BulkSetAttendanceOptions | undefined): Promise<BulkSetAttendanceResponse & BulkSetAttendanceResponseNonNullableFields>;
|
|
21629
21623
|
}
|
|
21630
21624
|
declare function queryAttendance$1(httpClient: HttpClient): QueryAttendanceSignature;
|
|
21631
21625
|
interface QueryAttendanceSignature {
|
|
21632
21626
|
/**
|
|
21633
|
-
*
|
|
21627
|
+
* Creates a query to retrieve a list of attendances.
|
|
21634
21628
|
*
|
|
21629
|
+
* The `queryAttendances()` function builds a query to retrieve a list of attendances and returns a `AttendancesQueryBuilder` object.
|
|
21635
21630
|
*
|
|
21636
|
-
*
|
|
21637
|
-
* + **A booking.** Specify a booking ID to retrieve attendance information
|
|
21638
|
-
* for all sessions related to that booking.
|
|
21639
|
-
* + **A session.** Specify a session ID to retrieve attendance information
|
|
21640
|
-
* for all bookings related to that session.
|
|
21631
|
+
* The returned object contains the query definition, which is typically used to call the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/bookings/attendance/attendances-query-builder/find) function.
|
|
21641
21632
|
*
|
|
21642
|
-
*
|
|
21643
|
-
* retrieve the attendance of a given participant in a course. For example, this query
|
|
21644
|
-
* helps you determine if a participant booked the course
|
|
21645
|
-
* but did not attend most of its sessions, taking away spots for other potential participants.
|
|
21633
|
+
* You can refine the query by chaining `AttendancesQueryBuilder` functions onto the query. `AttendancesQueryBuilder` functions enable you to sort, filter, and control the results that `queryAttendances()` returns.
|
|
21646
21634
|
*
|
|
21647
|
-
*
|
|
21635
|
+
* `queryAttendances()` uses the following `AttendancesQueryBuilder` default values that you can override:
|
|
21648
21636
|
*
|
|
21649
|
-
*
|
|
21650
|
-
*
|
|
21651
|
-
*
|
|
21652
|
-
* For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/attendance/supported-filters).
|
|
21637
|
+
* + `limit` is `50`.
|
|
21638
|
+
* + Sorted by `id` in ascending order.
|
|
21653
21639
|
*
|
|
21654
|
-
*
|
|
21655
|
-
* > + Another way to retrieve attendance information is to call Bookings Reader V2's [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceDetails` as `true`.
|
|
21656
|
-
* > + Up to 100 results can be returned per request.
|
|
21657
|
-
* > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
|
|
21640
|
+
* The functions that are chained to `queryAttendances()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("numberOfAttendees")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"numberOfAttendees"`.
|
|
21658
21641
|
*
|
|
21659
|
-
*
|
|
21660
|
-
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
|
|
21642
|
+
* The following `AttendancesQueryBuilder` functions are supported for the `queryAttendances()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/bookings/attendance/attendances-query-result/items) property in `AttendancesQueryResult`.
|
|
21661
21643
|
*/
|
|
21662
21644
|
(): AttendancesQueryBuilder;
|
|
21663
21645
|
}
|
|
@@ -22191,7 +22173,6 @@ interface ServiceChoice$1 extends ServiceChoiceChoiceOneOf$1 {
|
|
|
22191
22173
|
* Each choice may have a different price.
|
|
22192
22174
|
*/
|
|
22193
22175
|
custom?: string;
|
|
22194
|
-
duration?: Duration$1;
|
|
22195
22176
|
/**
|
|
22196
22177
|
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
22197
22178
|
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
@@ -22208,7 +22189,6 @@ interface ServiceChoiceChoiceOneOf$1 {
|
|
|
22208
22189
|
* Each choice may have a different price.
|
|
22209
22190
|
*/
|
|
22210
22191
|
custom?: string;
|
|
22211
|
-
duration?: Duration$1;
|
|
22212
22192
|
}
|
|
22213
22193
|
interface Duration$1 {
|
|
22214
22194
|
/**
|
|
@@ -24288,30 +24268,30 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
24288
24268
|
*/
|
|
24289
24269
|
entityEventSequence?: string | null;
|
|
24290
24270
|
}
|
|
24291
|
-
interface BookingCreatedEnvelope {
|
|
24292
|
-
entity: Booking$1;
|
|
24293
|
-
metadata: EventMetadata;
|
|
24294
|
-
}
|
|
24295
|
-
interface BookingRescheduledEnvelope {
|
|
24296
|
-
data: BookingRescheduled;
|
|
24297
|
-
metadata: EventMetadata;
|
|
24298
|
-
}
|
|
24299
24271
|
interface BookingCanceledEnvelope {
|
|
24300
24272
|
data: BookingCanceled;
|
|
24301
24273
|
metadata: EventMetadata;
|
|
24302
24274
|
}
|
|
24303
|
-
interface BookingUpdatedEnvelope {
|
|
24304
|
-
entity: Booking$1;
|
|
24305
|
-
metadata: EventMetadata;
|
|
24306
|
-
}
|
|
24307
24275
|
interface BookingConfirmedEnvelope {
|
|
24308
24276
|
data: BookingConfirmed;
|
|
24309
24277
|
metadata: EventMetadata;
|
|
24310
24278
|
}
|
|
24279
|
+
interface BookingCreatedEnvelope {
|
|
24280
|
+
entity: Booking$1;
|
|
24281
|
+
metadata: EventMetadata;
|
|
24282
|
+
}
|
|
24311
24283
|
interface BookingDeclinedEnvelope {
|
|
24312
24284
|
data: BookingDeclined;
|
|
24313
24285
|
metadata: EventMetadata;
|
|
24314
24286
|
}
|
|
24287
|
+
interface BookingRescheduledEnvelope {
|
|
24288
|
+
data: BookingRescheduled;
|
|
24289
|
+
metadata: EventMetadata;
|
|
24290
|
+
}
|
|
24291
|
+
interface BookingUpdatedEnvelope {
|
|
24292
|
+
entity: Booking$1;
|
|
24293
|
+
metadata: EventMetadata;
|
|
24294
|
+
}
|
|
24315
24295
|
interface BookingNumberOfParticipantsUpdatedEnvelope {
|
|
24316
24296
|
data: NumberOfParticipantsUpdated;
|
|
24317
24297
|
metadata: EventMetadata;
|
|
@@ -24967,12 +24947,12 @@ interface ConfirmOrDeclineBookingSignature {
|
|
|
24967
24947
|
*/
|
|
24968
24948
|
(bookingId: string, options?: ConfirmOrDeclineBookingOptions | undefined): Promise<ConfirmOrDeclineBookingResponse & ConfirmOrDeclineBookingResponseNonNullableFields>;
|
|
24969
24949
|
}
|
|
24970
|
-
declare const onBookingCreated$1: EventDefinition<BookingCreatedEnvelope, "wix.bookings.v2.booking_created">;
|
|
24971
|
-
declare const onBookingRescheduled$1: EventDefinition<BookingRescheduledEnvelope, "wix.bookings.v2.booking_rescheduled">;
|
|
24972
24950
|
declare const onBookingCanceled$1: EventDefinition<BookingCanceledEnvelope, "wix.bookings.v2.booking_canceled">;
|
|
24973
|
-
declare const onBookingUpdated$1: EventDefinition<BookingUpdatedEnvelope, "wix.bookings.v2.booking_updated">;
|
|
24974
24951
|
declare const onBookingConfirmed$1: EventDefinition<BookingConfirmedEnvelope, "wix.bookings.v2.booking_confirmed">;
|
|
24952
|
+
declare const onBookingCreated$1: EventDefinition<BookingCreatedEnvelope, "wix.bookings.v2.booking_created">;
|
|
24975
24953
|
declare const onBookingDeclined$1: EventDefinition<BookingDeclinedEnvelope, "wix.bookings.v2.booking_declined">;
|
|
24954
|
+
declare const onBookingRescheduled$1: EventDefinition<BookingRescheduledEnvelope, "wix.bookings.v2.booking_rescheduled">;
|
|
24955
|
+
declare const onBookingUpdated$1: EventDefinition<BookingUpdatedEnvelope, "wix.bookings.v2.booking_updated">;
|
|
24976
24956
|
declare const onBookingNumberOfParticipantsUpdated$1: EventDefinition<BookingNumberOfParticipantsUpdatedEnvelope, "wix.bookings.v2.booking_number_of_participants_updated">;
|
|
24977
24957
|
|
|
24978
24958
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
@@ -24999,40 +24979,40 @@ declare const cancelBooking: MaybeContext<BuildRESTFunction<typeof cancelBooking
|
|
|
24999
24979
|
declare const updateNumberOfParticipants: MaybeContext<BuildRESTFunction<typeof updateNumberOfParticipants$1> & typeof updateNumberOfParticipants$1>;
|
|
25000
24980
|
declare const confirmOrDeclineBooking: MaybeContext<BuildRESTFunction<typeof confirmOrDeclineBooking$1> & typeof confirmOrDeclineBooking$1>;
|
|
25001
24981
|
|
|
25002
|
-
type _publicOnBookingCreatedType = typeof onBookingCreated$1;
|
|
25003
|
-
/**
|
|
25004
|
-
* Triggered when a booking is created.
|
|
25005
|
-
*/
|
|
25006
|
-
declare const onBookingCreated: ReturnType<typeof createEventModule<_publicOnBookingCreatedType>>;
|
|
25007
|
-
|
|
25008
|
-
type _publicOnBookingRescheduledType = typeof onBookingRescheduled$1;
|
|
25009
|
-
/**
|
|
25010
|
-
* Triggered when a booking is rescheduled.
|
|
25011
|
-
*/
|
|
25012
|
-
declare const onBookingRescheduled: ReturnType<typeof createEventModule<_publicOnBookingRescheduledType>>;
|
|
25013
|
-
|
|
25014
24982
|
type _publicOnBookingCanceledType = typeof onBookingCanceled$1;
|
|
25015
24983
|
/**
|
|
25016
24984
|
* Triggered when a booking is canceled.
|
|
25017
24985
|
*/
|
|
25018
24986
|
declare const onBookingCanceled: ReturnType<typeof createEventModule<_publicOnBookingCanceledType>>;
|
|
25019
24987
|
|
|
25020
|
-
type _publicOnBookingUpdatedType = typeof onBookingUpdated$1;
|
|
25021
|
-
/** */
|
|
25022
|
-
declare const onBookingUpdated: ReturnType<typeof createEventModule<_publicOnBookingUpdatedType>>;
|
|
25023
|
-
|
|
25024
24988
|
type _publicOnBookingConfirmedType = typeof onBookingConfirmed$1;
|
|
25025
24989
|
/**
|
|
25026
24990
|
* Triggered when a booking is confirmed.
|
|
25027
24991
|
*/
|
|
25028
24992
|
declare const onBookingConfirmed: ReturnType<typeof createEventModule<_publicOnBookingConfirmedType>>;
|
|
25029
24993
|
|
|
24994
|
+
type _publicOnBookingCreatedType = typeof onBookingCreated$1;
|
|
24995
|
+
/**
|
|
24996
|
+
* Triggered when a booking is created.
|
|
24997
|
+
*/
|
|
24998
|
+
declare const onBookingCreated: ReturnType<typeof createEventModule<_publicOnBookingCreatedType>>;
|
|
24999
|
+
|
|
25030
25000
|
type _publicOnBookingDeclinedType = typeof onBookingDeclined$1;
|
|
25031
25001
|
/**
|
|
25032
25002
|
* Triggered when a booking is declined.
|
|
25033
25003
|
*/
|
|
25034
25004
|
declare const onBookingDeclined: ReturnType<typeof createEventModule<_publicOnBookingDeclinedType>>;
|
|
25035
25005
|
|
|
25006
|
+
type _publicOnBookingRescheduledType = typeof onBookingRescheduled$1;
|
|
25007
|
+
/**
|
|
25008
|
+
* Triggered when a booking is rescheduled.
|
|
25009
|
+
*/
|
|
25010
|
+
declare const onBookingRescheduled: ReturnType<typeof createEventModule<_publicOnBookingRescheduledType>>;
|
|
25011
|
+
|
|
25012
|
+
type _publicOnBookingUpdatedType = typeof onBookingUpdated$1;
|
|
25013
|
+
/** */
|
|
25014
|
+
declare const onBookingUpdated: ReturnType<typeof createEventModule<_publicOnBookingUpdatedType>>;
|
|
25015
|
+
|
|
25036
25016
|
type _publicOnBookingNumberOfParticipantsUpdatedType = typeof onBookingNumberOfParticipantsUpdated$1;
|
|
25037
25017
|
/**
|
|
25038
25018
|
* Triggered when the number of participants is updated.
|
|
@@ -25392,7 +25372,6 @@ interface ServiceChoice extends ServiceChoiceChoiceOneOf {
|
|
|
25392
25372
|
* Each choice may have a different price.
|
|
25393
25373
|
*/
|
|
25394
25374
|
custom?: string;
|
|
25395
|
-
duration?: Duration;
|
|
25396
25375
|
/**
|
|
25397
25376
|
* ID of the corresponding option for the choice. For example, the choice `child`
|
|
25398
25377
|
* could correspond to the option `ageGroup`. In this case, `optionId` is the ID
|
|
@@ -25409,7 +25388,6 @@ interface ServiceChoiceChoiceOneOf {
|
|
|
25409
25388
|
* Each choice may have a different price.
|
|
25410
25389
|
*/
|
|
25411
25390
|
custom?: string;
|
|
25412
|
-
duration?: Duration;
|
|
25413
25391
|
}
|
|
25414
25392
|
interface Duration {
|
|
25415
25393
|
/**
|