@wix/bookings 1.0.148 → 1.0.150

package/build/cjs/src/bookings-v2-attendance.http.d.ts

@@ -1,38 +1,49 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { GetAttendanceRequest, GetAttendanceResponse, QueryAttendanceRequest, QueryAttendanceResponse, SetAttendanceRequest, SetAttendanceResponse } from './bookings-v2-attendance.types';
-/** Get an Attendance by attendance id. */
+/** Retrieves attendance information by ID. */
 export declare function getAttendance(payload: GetAttendanceRequest): RequestOptionsFactory<GetAttendanceResponse>;
 /**
- * Create an Attendance or Update the status and numberOfAttendees in an existing Attendance of a given booking.
- * If the Attendance to set has no numberOfAttendees, it will get the default value of 1.
- * The number of attendees can be greater than 1 when the booking is made for a group of people.
+ * Sets information about whether a booking's session was attended. This information
+ * is saved in an `attendance` object.
  *
- * __Notes:__
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and `attendanceStatus`.
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and the booking's `numberOfParticipants`.
+ *
+ * If attendance was already set, meaning the `attendance` object already exists, the
+ * existing attendance information is updated. Otherwise, a new `attendance` object
+ * is created.
+ *
+ * By default, the number
+ * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
+ * participants attend. Do not set to `0` to indicate that no one attended the session.
+ * Instead, set the `status` field to `NOT_ATTENDED`.
+ *
+ * > __Note:__ Make sure your code validates that:
+ * >  + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
+ * >  + 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).
  */
 export declare function setAttendance(payload: SetAttendanceRequest): RequestOptionsFactory<SetAttendanceResponse>;
 /**
- * Retrieves a list of bookings Attendances, according to the provided paging, filtering, and sorting.
+ * Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
+ *
  *
- * Up to 100 bookings can be returned per request.
+ * When querying attendance information, you can query from the perspective of:
+ * + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
+ * + **A session.** Specify a session ID to  retrieve attendance information for all bookings related to that session.
+ *
+ * For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
+ * had no attendees. Was there bad weather on those days? Or was
+ * there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
  *
  * Query Attendance runs with the following defaults, which you can override:
  *
  * - `id` sorted in `ASC` order
  * - `cursorPaging.limit` is `50`
  *
- * For field support see
- * [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
- * for more information.
- *
- * __Notes__:
- * +  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.
- * + `fields` and `fieldsets` aren't supported.
- *
+ * For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
  *
- * You can only specify a filter only once per query. If a filter is provided
- * more than once, only the first occurrence affects the returned bookings.
+ * > __Notes__:
+ * > + 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`.
+ * > + Up to 100 results can be returned per request.
+ * > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
  *
  * To learn about working with _Query_ endpoints, see
  * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),

package/build/cjs/src/bookings-v2-attendance.http.js

@@ -63,7 +63,7 @@ function resolveComWixpressBookingsAttendanceV2AttendanceServiceUrl(opts) {
     };
     return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
-/** Get an Attendance by attendance id. */
+/** Retrieves attendance information by ID. */
 function getAttendance(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getAttendanceRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getAttendanceResponse, {});
@@ -88,13 +88,22 @@ function getAttendance(payload) {
 }
 exports.getAttendance = getAttendance;
 /**
- * Create an Attendance or Update the status and numberOfAttendees in an existing Attendance of a given booking.
- * If the Attendance to set has no numberOfAttendees, it will get the default value of 1.
- * The number of attendees can be greater than 1 when the booking is made for a group of people.
+ * Sets information about whether a booking's session was attended. This information
+ * is saved in an `attendance` object.
  *
- * __Notes:__
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and `attendanceStatus`.
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and the booking's `numberOfParticipants`.
+ *
+ * If attendance was already set, meaning the `attendance` object already exists, the
+ * existing attendance information is updated. Otherwise, a new `attendance` object
+ * is created.
+ *
+ * By default, the number
+ * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
+ * participants attend. Do not set to `0` to indicate that no one attended the session.
+ * Instead, set the `status` field to `NOT_ATTENDED`.
+ *
+ * > __Note:__ Make sure your code validates that:
+ * >  + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
+ * >  + 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).
  */
 function setAttendance(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_setAttendanceRequest, {});
@@ -120,26 +129,28 @@ function setAttendance(payload) {
 }
 exports.setAttendance = setAttendance;
 /**
- * Retrieves a list of bookings Attendances, according to the provided paging, filtering, and sorting.
+ * Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
+ *
  *
- * Up to 100 bookings can be returned per request.
+ * When querying attendance information, you can query from the perspective of:
+ * + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
+ * + **A session.** Specify a session ID to  retrieve attendance information for all bookings related to that session.
+ *
+ * For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
+ * had no attendees. Was there bad weather on those days? Or was
+ * there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
  *
  * Query Attendance runs with the following defaults, which you can override:
  *
  * - `id` sorted in `ASC` order
  * - `cursorPaging.limit` is `50`
  *
- * For field support see
- * [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
- * for more information.
- *
- * __Notes__:
- * +  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.
- * + `fields` and `fieldsets` aren't supported.
- *
+ * For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
  *
- * You can only specify a filter only once per query. If a filter is provided
- * more than once, only the first occurrence affects the returned bookings.
+ * > __Notes__:
+ * > + 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`.
+ * > + Up to 100 results can be returned per request.
+ * > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
  *
  * To learn about working with _Query_ endpoints, see
  * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),

package/build/cjs/src/bookings-v2-attendance.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-v2-attendance.http.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;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,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,0CAA0C;AAC1C,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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,IAAA,iCAAiB,EAAC,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;AA/BD,sCA+BC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA/BD,sCA+BC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,uBAAuB,EACvB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA/BD,0CA+BC"}
+{"version":3,"file":"bookings-v2-attendance.http.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;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,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,8CAA8C;AAC9C,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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,IAAA,iCAAiB,EAAC,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;AA/BD,sCA+BC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA/BD,sCA+BC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,uBAAuB,EACvB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,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;AA/BD,0CA+BC"}

package/build/cjs/src/bookings-v2-attendance.types.d.ts

@@ -1,26 +1,34 @@
 /**
- * Attendance is the main entity of AttendanceService.
- * It contains the attendance information for a given booking in a given session.
+ * The `attendance` object is the main entity of Attendance.
+ * This object contains the attendance information for a booked session, such as if anyone attended the session and if so, how many.
  */
 export interface Attendance {
     /**
-     * ID of the attendance object.
+     * ID of the `attendance` object.
      * @readonly
      */
     id?: string | null;
-    /** Booking ID. */
+    /** Corresponding booking ID. */
     bookingId?: string | null;
-    /** Session ID. */
+    /** Corresponding session ID. */
     sessionId?: string | null;
     /**
-     * Whether the booked contact attended the session, might be one of the following:
+     * Status indicating if any particpants attended the session:
      *
      * + `NOT_SET`: There is no available attendance information.
-     * + `ATTENDED`: At least a single participant has attended the session.
-     * + `NOT_ATTENDED`: No participant has attended the session.
+     * + `ATTENDED`: At least a single participant attended the session.
+     * + `NOT_ATTENDED`: No participants attended the session.
      */
     status?: AttendanceStatus;
-    /** Total number of participants who have that attended the session. Can be greater than `1` for bookings with multiple participants. */
+    /**
+     * Total number of participants that attended the session. By default, the number
+     * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
+     * participants attend.
+     *
+     * Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.
+     *
+     * Default: 1
+     */
     numberOfAttendees?: number;
 }
 export declare enum AttendanceStatus {
@@ -29,33 +37,49 @@ export declare enum AttendanceStatus {
     NOT_ATTENDED = "NOT_ATTENDED"
 }
 export interface GetAttendanceRequest {
-    /** Id of the Attendance to retrieve. */
+    /** ID of the object that contains the attendance information that you want to retrieve. */
     attendanceId: string;
 }
 export interface GetAttendanceResponse {
-    /** The retrieved Attendance. */
+    /** The retrieved attendance information for the booked session. */
     attendance?: Attendance;
 }
 export interface SetAttendanceRequest {
-    /** Attendance to create or updated. */
+    /** The attendance information for a booked session that you want to create or update. */
     attendance: Attendance;
 }
 export interface SetAttendanceResponse {
-    /** The updated Attendance. */
+    /** The created or updated attendance information for the booked session. */
     attendance?: Attendance;
 }
 export interface QueryAttendanceRequest {
-    /** WQL expression. */
+    /** Query options. */
     query: QueryV2;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Cursors to navigate through the result pages using `next` and `prev`. */
     cursorPaging?: CursorPaging;
+    /**
+     * Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+     *
+     * For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
+     *
+     * Max: 1 filter
+     */
     filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[ {"fieldName":"sortField1","order":"ASC"}, {"fieldName":"sortField2","order":"DESC"} ]`
+     *
+     * For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
+     */
     sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. */
     fields?: string[];
 }
 /** @oneof */
 export interface QueryV2PagingMethodOneOf {
+    /** Cursors to navigate through the result pages using `next` and `prev`. */
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
@@ -64,6 +88,11 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
+/**
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+ *
+ * Default: `ASC`.
+ */
 export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
@@ -76,26 +105,32 @@ export interface Paging {
 }
 export interface CursorPaging {
     /**
-     * Number of attendances to return.
-     * Defaults to `50`. Maximum `1000`.
+     * Number of `attendance` objects to return.
+     *
+     * Default: `50`
+     * Maximum: `1000`
      */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
+     *
      * You can get the relevant cursor token
      * from the `pagingMetadata` object in the previous call's response.
+     *
      * Not relevant for the first request.
      */
     cursor?: string | null;
 }
+/** List of objects that contain attendance information. */
 export interface QueryAttendanceResponse {
-    /** The retrieved Attendances. */
+    /** List of objects that contain attendance information for a booked session. */
     attendances?: Attendance[];
-    /** Paging Metadata. Cursor pagination is supported. */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata;
 }
+/** This is the preferred message for cursor-paging enabled services */
 export interface CursorPagingMetadata {
-    /** 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). */
+    /** 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). */
     cursors?: Cursors;
     /**
      * Indicates if there are more results after the current page.

package/build/cjs/src/bookings-v2-attendance.types.js

@@ -7,6 +7,11 @@ var AttendanceStatus;
     AttendanceStatus["ATTENDED"] = "ATTENDED";
     AttendanceStatus["NOT_ATTENDED"] = "NOT_ATTENDED";
 })(AttendanceStatus = exports.AttendanceStatus || (exports.AttendanceStatus = {}));
+/**
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+ *
+ * Default: `ASC`.
+ */
 var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";

package/build/cjs/src/bookings-v2-attendance.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"bookings-v2-attendance.types.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.types.ts"],"names":[],"mappings":";;;AA0BA,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,yCAAqB,CAAA;IACrB,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AA8CD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}
+{"version":3,"file":"bookings-v2-attendance.types.js","sourceRoot":"","sources":["../../../src/bookings-v2-attendance.types.ts"],"names":[],"mappings":";;;AAkCA,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"}

package/build/cjs/src/bookings-v2-attendance.universal.d.ts

@@ -5,28 +5,36 @@ export declare const __debug: {
     };
 };
 /**
- * Attendance is the main entity of AttendanceService.
- * It contains the attendance information for a given booking in a given session.
+ * The `attendance` object is the main entity of Attendance.
+ * This object contains the attendance information for a booked session, such as if anyone attended the session and if so, how many.
  */
 export interface Attendance {
     /**
-     * ID of the attendance object.
+     * ID of the `attendance` object.
      * @readonly
      */
     _id?: string | null;
-    /** Booking ID. */
+    /** Corresponding booking ID. */
     bookingId?: string | null;
-    /** Session ID. */
+    /** Corresponding session ID. */
     sessionId?: string | null;
     /**
-     * Whether the booked contact attended the session, might be one of the following:
+     * Status indicating if any particpants attended the session:
      *
      * + `NOT_SET`: There is no available attendance information.
-     * + `ATTENDED`: At least a single participant has attended the session.
-     * + `NOT_ATTENDED`: No participant has attended the session.
+     * + `ATTENDED`: At least a single participant attended the session.
+     * + `NOT_ATTENDED`: No participants attended the session.
      */
     status?: AttendanceStatus;
-    /** Total number of participants who have that attended the session. Can be greater than `1` for bookings with multiple participants. */
+    /**
+     * Total number of participants that attended the session. By default, the number
+     * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
+     * participants attend.
+     *
+     * Do not set to `0` to indicate that no one attended the session. Instead, set the `status` field to `NOT_ATTENDED`.
+     *
+     * Default: 1
+     */
     numberOfAttendees?: number;
 }
 export declare enum AttendanceStatus {
@@ -35,33 +43,49 @@ export declare enum AttendanceStatus {
     NOT_ATTENDED = "NOT_ATTENDED"
 }
 export interface GetAttendanceRequest {
-    /** Id of the Attendance to retrieve. */
+    /** ID of the object that contains the attendance information that you want to retrieve. */
     attendanceId: string;
 }
 export interface GetAttendanceResponse {
-    /** The retrieved Attendance. */
+    /** The retrieved attendance information for the booked session. */
     attendance?: Attendance;
 }
 export interface SetAttendanceRequest {
-    /** Attendance to create or updated. */
+    /** The attendance information for a booked session that you want to create or update. */
     attendance: Attendance;
 }
 export interface SetAttendanceResponse {
-    /** The updated Attendance. */
+    /** The created or updated attendance information for the booked session. */
     attendance?: Attendance;
 }
 export interface QueryAttendanceRequest {
-    /** WQL expression. */
+    /** Query options. */
     query: QueryV2;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Cursors to navigate through the result pages using `next` and `prev`. */
     cursorPaging?: CursorPaging;
+    /**
+     * Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.
+     *
+     * For a detailed list of supported fields and operators, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
+     *
+     * Max: 1 filter
+     */
     filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[ {"fieldName":"sortField1","order":"ASC"}, {"fieldName":"sortField2","order":"DESC"} ]`
+     *
+     * For details about sorting, see [Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-bookings/attendance/supportedfilters).
+     */
     sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. */
     fields?: string[];
 }
 /** @oneof */
 export interface QueryV2PagingMethodOneOf {
+    /** Cursors to navigate through the result pages using `next` and `prev`. */
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
@@ -70,6 +94,11 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
+/**
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+ *
+ * Default: `ASC`.
+ */
 export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
@@ -82,26 +111,32 @@ export interface Paging {
 }
 export interface CursorPaging {
     /**
-     * Number of attendances to return.
-     * Defaults to `50`. Maximum `1000`.
+     * Number of `attendance` objects to return.
+     *
+     * Default: `50`
+     * Maximum: `1000`
      */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
+     *
      * You can get the relevant cursor token
      * from the `pagingMetadata` object in the previous call's response.
+     *
      * Not relevant for the first request.
      */
     cursor?: string | null;
 }
+/** List of objects that contain attendance information. */
 export interface QueryAttendanceResponse {
-    /** The retrieved Attendances. */
+    /** List of objects that contain attendance information for a booked session. */
     attendances?: Attendance[];
-    /** Paging Metadata. Cursor pagination is supported. */
+    /** Details on the paged set of results returned. */
     pagingMetadata?: CursorPagingMetadata;
 }
+/** This is the preferred message for cursor-paging enabled services */
 export interface CursorPagingMetadata {
-    /** 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). */
+    /** 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). */
     cursors?: Cursors;
     /**
      * Indicates if there are more results after the current page.
@@ -117,24 +152,33 @@ export interface Cursors {
     prev?: string | null;
 }
 /**
- * Get an Attendance by attendance id.
- * @param attendanceId - Id of the Attendance to retrieve.
+ * Retrieves attendance information by ID.
+ * @param attendanceId - ID of the object that contains the attendance information that you want to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField attendanceId
  * @permissionScope Read Bookings - Including Participants
- * @returns The retrieved Attendance.
+ * @returns The retrieved attendance information for the booked session.
  */
 export declare function getAttendance(attendanceId: string): Promise<Attendance>;
 /**
- * Create an Attendance or Update the status and numberOfAttendees in an existing Attendance of a given booking.
- * If the Attendance to set has no numberOfAttendees, it will get the default value of 1.
- * The number of attendees can be greater than 1 when the booking is made for a group of people.
+ * Sets information about whether a booking's session was attended. This information
+ * is saved in an `attendance` object.
+ *
  *
- * __Notes:__
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and `attendanceStatus`.
- * + There is no validation on the number of attendees or on the relationship between `numberOfAttendees` and the booking's `numberOfParticipants`.
- * @param attendance - Attendance to create or updated.
+ * If attendance was already set, meaning the `attendance` object already exists, the
+ * existing attendance information is updated. Otherwise, a new `attendance` object
+ * is created.
+ *
+ * By default, the number
+ * of attendees is set to `1`, but you can set a number to greater than `1` if multiple
+ * participants attend. Do not set to `0` to indicate that no one attended the session.
+ * Instead, set the `status` field to `NOT_ATTENDED`.
+ *
+ * > __Note:__ Make sure your code validates that:
+ * >  + There is no mismatch between `numberOfAttendees` and `attendanceStatus` to make sure, for example, that `attendanceStatus` is not `NOT_ATTENDED` while `numberOfAttendees` is `5`.
+ * >  + 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).
+ * @param attendance - The attendance information for a booked session that you want to create or update.
  * @public
  * @documentationMaturity preview
  * @requiredField attendance
@@ -145,26 +189,28 @@ export declare function getAttendance(attendanceId: string): Promise<Attendance>
  */
 export declare function setAttendance(attendance: Attendance): Promise<SetAttendanceResponse>;
 /**
- * Retrieves a list of bookings Attendances, according to the provided paging, filtering, and sorting.
+ * Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
+ *
  *
- * Up to 100 bookings can be returned per request.
+ * When querying attendance information, you can query from the perspective of:
+ * + **A booking.** Specify a booking ID to retrieve attendance information for all sessions related to that booking.
+ * + **A session.** Specify a session ID to  retrieve attendance information for all bookings related to that session.
+ *
+ * For example, query by a course's `bookingId` and `status = "NOT_ATTENDED"` to retrieve course sessions for that booking that
+ * had no attendees. Was there bad weather on those days? Or was
+ * there a sudden drop in attendance due to a business reason that must be handled, like a less-qualified instructor?
  *
  * Query Attendance runs with the following defaults, which you can override:
  *
  * - `id` sorted in `ASC` order
  * - `cursorPaging.limit` is `50`
  *
- * For field support see
- * [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters)
- * for more information.
- *
- * __Notes__:
- * +  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.
- * + `fields` and `fieldsets` aren't supported.
- *
+ * For field support, see [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-attendance-v2/supported-filters).
  *
- * You can only specify a filter only once per query. If a filter is provided
- * more than once, only the first occurrence affects the returned bookings.
+ * > __Notes__:
+ * > + 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`.
+ * > + Up to 100 results can be returned per request.
+ * > + Only 1 filter is supported per query. If you define multiple filters in the same query, only the first is processed.
  *
  * To learn about working with _Query_ endpoints, see
  * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),