@wix/bookings 1.0.148 → 1.0.150
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/build/cjs/src/bookings-v2-attendance.http.d.ts +30 -19
- package/build/cjs/src/bookings-v2-attendance.http.js +30 -19
- package/build/cjs/src/bookings-v2-attendance.http.js.map +1 -1
- package/build/cjs/src/bookings-v2-attendance.types.d.ts +54 -19
- package/build/cjs/src/bookings-v2-attendance.types.js +5 -0
- package/build/cjs/src/bookings-v2-attendance.types.js.map +1 -1
- package/build/cjs/src/bookings-v2-attendance.universal.d.ts +87 -41
- package/build/cjs/src/bookings-v2-attendance.universal.js +38 -22
- package/build/cjs/src/bookings-v2-attendance.universal.js.map +1 -1
- package/build/es/src/bookings-v2-attendance.http.d.ts +30 -19
- package/build/es/src/bookings-v2-attendance.http.js +30 -19
- package/build/es/src/bookings-v2-attendance.http.js.map +1 -1
- package/build/es/src/bookings-v2-attendance.types.d.ts +54 -19
- package/build/es/src/bookings-v2-attendance.types.js +5 -0
- package/build/es/src/bookings-v2-attendance.types.js.map +1 -1
- package/build/es/src/bookings-v2-attendance.universal.d.ts +87 -41
- package/build/es/src/bookings-v2-attendance.universal.js +38 -22
- package/build/es/src/bookings-v2-attendance.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -54,6 +54,11 @@ var AttendanceStatus;
|
|
|
54
54
|
AttendanceStatus["ATTENDED"] = "ATTENDED";
|
|
55
55
|
AttendanceStatus["NOT_ATTENDED"] = "NOT_ATTENDED";
|
|
56
56
|
})(AttendanceStatus = exports.AttendanceStatus || (exports.AttendanceStatus = {}));
|
|
57
|
+
/**
|
|
58
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
59
|
+
*
|
|
60
|
+
* Default: `ASC`.
|
|
61
|
+
*/
|
|
57
62
|
var SortOrder;
|
|
58
63
|
(function (SortOrder) {
|
|
59
64
|
SortOrder["ASC"] = "ASC";
|
|
@@ -66,13 +71,13 @@ const _queryAttendanceResponse = {};
|
|
|
66
71
|
const _setAttendanceRequest = {};
|
|
67
72
|
const _setAttendanceResponse = {};
|
|
68
73
|
/**
|
|
69
|
-
*
|
|
70
|
-
* @param attendanceId -
|
|
74
|
+
* Retrieves attendance information by ID.
|
|
75
|
+
* @param attendanceId - ID of the object that contains the attendance information that you want to retrieve.
|
|
71
76
|
* @public
|
|
72
77
|
* @documentationMaturity preview
|
|
73
78
|
* @requiredField attendanceId
|
|
74
79
|
* @permissionScope Read Bookings - Including Participants
|
|
75
|
-
* @returns The retrieved
|
|
80
|
+
* @returns The retrieved attendance information for the booked session.
|
|
76
81
|
*/
|
|
77
82
|
function getAttendance(attendanceId) {
|
|
78
83
|
var _a, _b, _c;
|
|
@@ -119,14 +124,23 @@ function getAttendance(attendanceId) {
|
|
|
119
124
|
}
|
|
120
125
|
exports.getAttendance = getAttendance;
|
|
121
126
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
127
|
+
* Sets information about whether a booking's session was attended. This information
|
|
128
|
+
* is saved in an `attendance` object.
|
|
129
|
+
*
|
|
130
|
+
*
|
|
131
|
+
* If attendance was already set, meaning the `attendance` object already exists, the
|
|
132
|
+
* existing attendance information is updated. Otherwise, a new `attendance` object
|
|
133
|
+
* is created.
|
|
125
134
|
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
135
|
+
* By default, the number
|
|
136
|
+
* of attendees is set to `1`, but you can set a number to greater than `1` if multiple
|
|
137
|
+
* participants attend. Do not set to `0` to indicate that no one attended the session.
|
|
138
|
+
* Instead, set the `status` field to `NOT_ATTENDED`.
|
|
139
|
+
*
|
|
140
|
+
* > __Note:__ Make sure your code validates that:
|
|
141
|
+
* > + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
|
|
142
|
+
* > + The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).
|
|
143
|
+
* @param attendance - The attendance information for a booked session that you want to create or update.
|
|
130
144
|
* @public
|
|
131
145
|
* @documentationMaturity preview
|
|
132
146
|
* @requiredField attendance
|
|
@@ -180,26 +194,28 @@ function setAttendance(attendance) {
|
|
|
180
194
|
}
|
|
181
195
|
exports.setAttendance = setAttendance;
|
|
182
196
|
/**
|
|
183
|
-
* Retrieves
|
|
197
|
+
* Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
|
|
198
|
+
*
|
|
199
|
+
*
|
|
200
|
+
* When querying attendance information, you can query from the perspective of:
|
|
201
|
+
* + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
|
|
202
|
+
* + **A session.** Specify a session ID to retrieve attendance information for all bookings related to that session.
|
|
184
203
|
*
|
|
185
|
-
*
|
|
204
|
+
* For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
|
|
205
|
+
* had no attendees. Was there bad weather on those days? Or was
|
|
206
|
+
* there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
|
|
186
207
|
*
|
|
187
208
|
* Query Attendance runs with the following defaults, which you can override:
|
|
188
209
|
*
|
|
189
210
|
* - `id` sorted in `ASC` order
|
|
190
211
|
* - `cursorPaging.limit` is `50`
|
|
191
212
|
*
|
|
192
|
-
* For field support see
|
|
193
|
-
* [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
|
|
194
|
-
* for more information.
|
|
195
|
-
*
|
|
196
|
-
* __Notes__:
|
|
197
|
-
* + An alternative way to obtain attendance information for bookings can be done by calling BookingsReader [queryExtendedBookings] (https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceInfo` parameter set to true.
|
|
198
|
-
* + `fields` and `fieldsets` aren't supported.
|
|
199
|
-
*
|
|
213
|
+
* For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
|
|
200
214
|
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
215
|
+
* > __Notes__:
|
|
216
|
+
* > + 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 `withBookingAttendanceInfo` set to `true`.
|
|
217
|
+
* > + Up to 100 results can be returned per request.
|
|
218
|
+
* > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
|
|
203
219
|
*
|
|
204
220
|
* To learn about working with _Query_ endpoints, see
|
|
205
221
|
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-v2-attendance.universal.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,iGAAmF;AACnF,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"bookings-v2-attendance.universal.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,iGAAmF;AACnF,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAoC5B,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,yCAAqB,CAAA;IACrB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AA8DD;;;;GAIG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAuDD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;;;;;;;GAQG;AACH,SAAsB,aAAa,CAAC,YAAoB;;;QACtD,MAAM,qBAAqB,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;QACvD,MAAM,sBAAsB,GAAG,cAAc,CAAC;QAE9C,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAG,iCAAiC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,cAAc;aACf,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAlDD,sCAkDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAsB,aAAa,CACjC,UAAsB;;;QAEtB,MAAM,qBAAqB,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACrD,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,qBAAqB;YACjC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAElD,MAAM,OAAO,GAAG,iCAAiC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAEzE,KAAK,CAAC,yCAAyC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAErE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,YAAY;aACb,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AApDD,sCAoDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,eAAe;IAC7B,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC7D,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,eAAe;QACtB,cAAc,EAAE,kBAAkB;KACnC,CAAC;IAEF,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;QACzC,UAAU,EAAE,uBAAuB;QACnC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;QAC9B,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACjC,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,IAAA,uDAAoB,EAAC;QAC1B,IAAI,EAAE,CAAO,OAAY,EAAE,EAAE;;YAC3B,MAAM,OAAO,GACX,iCAAiC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAE7D,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;YAC5B,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAA;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,IAAA,4CAAqC,EAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA1DD,0CA0DC"}
|
|
@@ -1,38 +1,49 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
import { GetAttendanceRequest, GetAttendanceResponse, QueryAttendanceRequest, QueryAttendanceResponse, SetAttendanceRequest, SetAttendanceResponse } from './bookings-v2-attendance.types';
|
|
3
|
-
/**
|
|
3
|
+
/** Retrieves attendance information by ID. */
|
|
4
4
|
export declare function getAttendance(payload: GetAttendanceRequest): RequestOptionsFactory<GetAttendanceResponse>;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* The number of attendees can be greater than 1 when the booking is made for a group of people.
|
|
6
|
+
* Sets information about whether a booking's session was attended. This information
|
|
7
|
+
* is saved in an `attendance` object.
|
|
9
8
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
9
|
+
*
|
|
10
|
+
* If attendance was already set, meaning the `attendance` object already exists, the
|
|
11
|
+
* existing attendance information is updated. Otherwise, a new `attendance` object
|
|
12
|
+
* is created.
|
|
13
|
+
*
|
|
14
|
+
* By default, the number
|
|
15
|
+
* of attendees is set to `1`, but you can set a number to greater than `1` if multiple
|
|
16
|
+
* participants attend. Do not set to `0` to indicate that no one attended the session.
|
|
17
|
+
* Instead, set the `status` field to `NOT_ATTENDED`.
|
|
18
|
+
*
|
|
19
|
+
* > __Note:__ Make sure your code validates that:
|
|
20
|
+
* > + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
|
|
21
|
+
* > + The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).
|
|
13
22
|
*/
|
|
14
23
|
export declare function setAttendance(payload: SetAttendanceRequest): RequestOptionsFactory<SetAttendanceResponse>;
|
|
15
24
|
/**
|
|
16
|
-
* Retrieves
|
|
25
|
+
* Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
|
|
26
|
+
*
|
|
17
27
|
*
|
|
18
|
-
*
|
|
28
|
+
* When querying attendance information, you can query from the perspective of:
|
|
29
|
+
* + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
|
|
30
|
+
* + **A session.** Specify a session ID to retrieve attendance information for all bookings related to that session.
|
|
31
|
+
*
|
|
32
|
+
* For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
|
|
33
|
+
* had no attendees. Was there bad weather on those days? Or was
|
|
34
|
+
* there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
|
|
19
35
|
*
|
|
20
36
|
* Query Attendance runs with the following defaults, which you can override:
|
|
21
37
|
*
|
|
22
38
|
* - `id` sorted in `ASC` order
|
|
23
39
|
* - `cursorPaging.limit` is `50`
|
|
24
40
|
*
|
|
25
|
-
* For field support see
|
|
26
|
-
* [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
|
|
27
|
-
* for more information.
|
|
28
|
-
*
|
|
29
|
-
* __Notes__:
|
|
30
|
-
* + An alternative way to obtain attendance information for bookings can be done by calling BookingsReader [queryExtendedBookings] (https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceInfo` parameter set to true.
|
|
31
|
-
* + `fields` and `fieldsets` aren't supported.
|
|
32
|
-
*
|
|
41
|
+
* For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
|
|
33
42
|
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
43
|
+
* > __Notes__:
|
|
44
|
+
* > + 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 `withBookingAttendanceInfo` set to `true`.
|
|
45
|
+
* > + Up to 100 results can be returned per request.
|
|
46
|
+
* > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
|
|
36
47
|
*
|
|
37
48
|
* To learn about working with _Query_ endpoints, see
|
|
38
49
|
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
@@ -60,7 +60,7 @@ function resolveComWixpressBookingsAttendanceV2AttendanceServiceUrl(opts) {
|
|
|
60
60
|
};
|
|
61
61
|
return resolveUrl(Object.assign(opts, { domainToMappings }));
|
|
62
62
|
}
|
|
63
|
-
/**
|
|
63
|
+
/** Retrieves attendance information by ID. */
|
|
64
64
|
export function getAttendance(payload) {
|
|
65
65
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_getAttendanceRequest, {});
|
|
66
66
|
const { fromJSON: fromRes } = serializer(_getAttendanceResponse, {});
|
|
@@ -84,13 +84,22 @@ export function getAttendance(payload) {
|
|
|
84
84
|
return __getAttendance;
|
|
85
85
|
}
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* The number of attendees can be greater than 1 when the booking is made for a group of people.
|
|
87
|
+
* Sets information about whether a booking's session was attended. This information
|
|
88
|
+
* is saved in an `attendance` object.
|
|
90
89
|
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
90
|
+
*
|
|
91
|
+
* If attendance was already set, meaning the `attendance` object already exists, the
|
|
92
|
+
* existing attendance information is updated. Otherwise, a new `attendance` object
|
|
93
|
+
* is created.
|
|
94
|
+
*
|
|
95
|
+
* By default, the number
|
|
96
|
+
* of attendees is set to `1`, but you can set a number to greater than `1` if multiple
|
|
97
|
+
* participants attend. Do not set to `0` to indicate that no one attended the session.
|
|
98
|
+
* Instead, set the `status` field to `NOT_ATTENDED`.
|
|
99
|
+
*
|
|
100
|
+
* > __Note:__ Make sure your code validates that:
|
|
101
|
+
* > + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
|
|
102
|
+
* > + The attendance's `numberOfAttendees` and the booking's `numberOfParticipants` correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).
|
|
94
103
|
*/
|
|
95
104
|
export function setAttendance(payload) {
|
|
96
105
|
const { toJSON: toReq, fromJSON: fromReq } = serializer(_setAttendanceRequest, {});
|
|
@@ -115,26 +124,28 @@ export function setAttendance(payload) {
|
|
|
115
124
|
return __setAttendance;
|
|
116
125
|
}
|
|
117
126
|
/**
|
|
118
|
-
* Retrieves
|
|
127
|
+
* Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
|
|
128
|
+
*
|
|
119
129
|
*
|
|
120
|
-
*
|
|
130
|
+
* When querying attendance information, you can query from the perspective of:
|
|
131
|
+
* + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
|
|
132
|
+
* + **A session.** Specify a session ID to retrieve attendance information for all bookings related to that session.
|
|
133
|
+
*
|
|
134
|
+
* For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
|
|
135
|
+
* had no attendees. Was there bad weather on those days? Or was
|
|
136
|
+
* there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
|
|
121
137
|
*
|
|
122
138
|
* Query Attendance runs with the following defaults, which you can override:
|
|
123
139
|
*
|
|
124
140
|
* - `id` sorted in `ASC` order
|
|
125
141
|
* - `cursorPaging.limit` is `50`
|
|
126
142
|
*
|
|
127
|
-
* For field support see
|
|
128
|
-
* [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
|
|
129
|
-
* for more information.
|
|
130
|
-
*
|
|
131
|
-
* __Notes__:
|
|
132
|
-
* + An alternative way to obtain attendance information for bookings can be done by calling BookingsReader [queryExtendedBookings] (https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) with `withBookingAttendanceInfo` parameter set to true.
|
|
133
|
-
* + `fields` and `fieldsets` aren't supported.
|
|
134
|
-
*
|
|
143
|
+
* For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
|
|
135
144
|
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
145
|
+
* > __Notes__:
|
|
146
|
+
* > + 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 `withBookingAttendanceInfo` set to `true`.
|
|
147
|
+
* > + Up to 100 results can be returned per request.
|
|
148
|
+
* > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
|
|
138
149
|
*
|
|
139
150
|
* To learn about working with _Query_ endpoints, see
|
|
140
151
|
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-v2-attendance.http.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAYhD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,SAAS,0DAA0D,CACjE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,
|
|
1
|
+
{"version":3,"file":"bookings-v2-attendance.http.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAYhD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,SAAS,0DAA0D,CACjE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,+BAA+B;gBACxC,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,sBAAsB;gBAC/B,QAAQ,EAAE,gBAAgB;aAC3B;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,2BAA2B;gBACpC,QAAQ,EAAE,gBAAgB;aAC3B;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAErE,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,qEAAqE;YACvE,GAAG,EAAE,0DAA0D,CAAC;gBAC9D,SAAS,EAAE,+BAA+B;gBAC1C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAErE,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,qEAAqE;YACvE,GAAG,EAAE,0DAA0D,CAAC;gBAC9D,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,uBAAuB,EACvB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAEvE,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,uEAAuE;YACzE,GAAG,EAAE,0DAA0D,CAAC;gBAC9D,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iBAAiB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEpC,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}
|
|
@@ -1,26 +1,34 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* The `attendance` object is the main entity of Attendance.
|
|
3
|
+
* This object contains the attendance information for a booked session, such as if anyone attended the session and if so, how many.
|
|
4
4
|
*/
|
|
5
5
|
export interface Attendance {
|
|
6
6
|
/**
|
|
7
|
-
* ID of the attendance object.
|
|
7
|
+
* ID of the `attendance` object.
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
10
10
|
id?: string | null;
|
|
11
|
-
/**
|
|
11
|
+
/** Corresponding booking ID. */
|
|
12
12
|
bookingId?: string | null;
|
|
13
|
-
/**
|
|
13
|
+
/** Corresponding session ID. */
|
|
14
14
|
sessionId?: string | null;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Status indicating if any particpants attended the session:
|
|
17
17
|
*
|
|
18
18
|
* + `NOT_SET`: There is no available attendance information.
|
|
19
|
-
* + `ATTENDED`: At least a single participant
|
|
20
|
-
* + `NOT_ATTENDED`: No
|
|
19
|
+
* + `ATTENDED`: At least a single participant attended the session.
|
|
20
|
+
* + `NOT_ATTENDED`: No participants attended the session.
|
|
21
21
|
*/
|
|
22
22
|
status?: AttendanceStatus;
|
|
23
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Total number of participants that attended the session. By default, the number
|
|
25
|
+
* of attendees is set to `1`, but you can set a number to greater than `1` if multiple
|
|
26
|
+
* participants attend.
|
|
27
|
+
*
|
|
28
|
+
* Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.
|
|
29
|
+
*
|
|
30
|
+
* Default: 1
|
|
31
|
+
*/
|
|
24
32
|
numberOfAttendees?: number;
|
|
25
33
|
}
|
|
26
34
|
export declare enum AttendanceStatus {
|
|
@@ -29,33 +37,49 @@ export declare enum AttendanceStatus {
|
|
|
29
37
|
NOT_ATTENDED = "NOT_ATTENDED"
|
|
30
38
|
}
|
|
31
39
|
export interface GetAttendanceRequest {
|
|
32
|
-
/**
|
|
40
|
+
/** ID of the object that contains the attendance information that you want to retrieve. */
|
|
33
41
|
attendanceId: string;
|
|
34
42
|
}
|
|
35
43
|
export interface GetAttendanceResponse {
|
|
36
|
-
/** The retrieved
|
|
44
|
+
/** The retrieved attendance information for the booked session. */
|
|
37
45
|
attendance?: Attendance;
|
|
38
46
|
}
|
|
39
47
|
export interface SetAttendanceRequest {
|
|
40
|
-
/**
|
|
48
|
+
/** The attendance information for a booked session that you want to create or update. */
|
|
41
49
|
attendance: Attendance;
|
|
42
50
|
}
|
|
43
51
|
export interface SetAttendanceResponse {
|
|
44
|
-
/** The updated
|
|
52
|
+
/** The created or updated attendance information for the booked session. */
|
|
45
53
|
attendance?: Attendance;
|
|
46
54
|
}
|
|
47
55
|
export interface QueryAttendanceRequest {
|
|
48
|
-
/**
|
|
56
|
+
/** Query options. */
|
|
49
57
|
query: QueryV2;
|
|
50
58
|
}
|
|
51
59
|
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
60
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. */
|
|
52
61
|
cursorPaging?: CursorPaging;
|
|
62
|
+
/**
|
|
63
|
+
* Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
|
|
64
|
+
*
|
|
65
|
+
* For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
|
|
66
|
+
*
|
|
67
|
+
* Max: 1 filter
|
|
68
|
+
*/
|
|
53
69
|
filter?: Record<string, any> | null;
|
|
70
|
+
/**
|
|
71
|
+
* Sort object in the following format:
|
|
72
|
+
* `[ {"fieldName":"sortField1","order":"ASC"}, {"fieldName":"sortField2","order":"DESC"} ]`
|
|
73
|
+
*
|
|
74
|
+
* For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
|
|
75
|
+
*/
|
|
54
76
|
sort?: Sorting[];
|
|
77
|
+
/** Array of projected fields. A list of specific field names to return. */
|
|
55
78
|
fields?: string[];
|
|
56
79
|
}
|
|
57
80
|
/** @oneof */
|
|
58
81
|
export interface QueryV2PagingMethodOneOf {
|
|
82
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. */
|
|
59
83
|
cursorPaging?: CursorPaging;
|
|
60
84
|
}
|
|
61
85
|
export interface Sorting {
|
|
@@ -64,6 +88,11 @@ export interface Sorting {
|
|
|
64
88
|
/** Sort order. */
|
|
65
89
|
order?: SortOrder;
|
|
66
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
93
|
+
*
|
|
94
|
+
* Default: `ASC`.
|
|
95
|
+
*/
|
|
67
96
|
export declare enum SortOrder {
|
|
68
97
|
ASC = "ASC",
|
|
69
98
|
DESC = "DESC"
|
|
@@ -76,26 +105,32 @@ export interface Paging {
|
|
|
76
105
|
}
|
|
77
106
|
export interface CursorPaging {
|
|
78
107
|
/**
|
|
79
|
-
* Number of
|
|
80
|
-
*
|
|
108
|
+
* Number of `attendance` objects to return.
|
|
109
|
+
*
|
|
110
|
+
* Default: `50`
|
|
111
|
+
* Maximum: `1000`
|
|
81
112
|
*/
|
|
82
113
|
limit?: number | null;
|
|
83
114
|
/**
|
|
84
115
|
* Pointer to the next or previous page in the list of results.
|
|
116
|
+
*
|
|
85
117
|
* You can get the relevant cursor token
|
|
86
118
|
* from the `pagingMetadata` object in the previous call's response.
|
|
119
|
+
*
|
|
87
120
|
* Not relevant for the first request.
|
|
88
121
|
*/
|
|
89
122
|
cursor?: string | null;
|
|
90
123
|
}
|
|
124
|
+
/** List of objects that contain attendance information. */
|
|
91
125
|
export interface QueryAttendanceResponse {
|
|
92
|
-
/**
|
|
126
|
+
/** List of objects that contain attendance information for a booked session. */
|
|
93
127
|
attendances?: Attendance[];
|
|
94
|
-
/**
|
|
128
|
+
/** Details on the paged set of results returned. */
|
|
95
129
|
pagingMetadata?: CursorPagingMetadata;
|
|
96
130
|
}
|
|
131
|
+
/** This is the preferred message for cursor-paging enabled services */
|
|
97
132
|
export interface CursorPagingMetadata {
|
|
98
|
-
/** Use these
|
|
133
|
+
/** Use these cursors to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
99
134
|
cursors?: Cursors;
|
|
100
135
|
/**
|
|
101
136
|
* Indicates if there are more results after the current page.
|
|
@@ -4,6 +4,11 @@ export var AttendanceStatus;
|
|
|
4
4
|
AttendanceStatus["ATTENDED"] = "ATTENDED";
|
|
5
5
|
AttendanceStatus["NOT_ATTENDED"] = "NOT_ATTENDED";
|
|
6
6
|
})(AttendanceStatus || (AttendanceStatus = {}));
|
|
7
|
+
/**
|
|
8
|
+
* Sort order. Use `ASC` for ascending order or `DESC` for descending order.
|
|
9
|
+
*
|
|
10
|
+
* Default: `ASC`.
|
|
11
|
+
*/
|
|
7
12
|
export var SortOrder;
|
|
8
13
|
(function (SortOrder) {
|
|
9
14
|
SortOrder["ASC"] = "ASC";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-v2-attendance.types.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"bookings-v2-attendance.types.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.types.ts"],"names":[],"mappings":"AAkCA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,yCAAqB,CAAA;IACrB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA8DD;;;;GAIG;AACH,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}
|