@wix/auto_sdk_bookings_attendance 1.0.14 → 1.0.16

package/build/{es/src/bookings-v2-attendance-attendance.types.d.ts → bookings-v2-attendance-attendance.universal-BKW7diO6.d.mts}

@@ -10,13 +10,13 @@
  * + 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.
  * + 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.
  */
-export interface Attendance {
+interface Attendance {
     /**
      * ID of the `attendance` object.
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * Corresponding booking ID.
      * @format GUID
@@ -37,7 +37,7 @@ export interface Attendance {
      */
     numberOfAttendees?: number;
 }
-export declare enum AttendanceStatus {
+declare enum AttendanceStatus {
     /** There is no available attendance information. */
     NOT_SET = "NOT_SET",
     /** At least a single participant attended the session. */
@@ -46,25 +46,25 @@ export declare enum AttendanceStatus {
     NOT_ATTENDED = "NOT_ATTENDED"
 }
 /** @enumType */
-export type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_SET' | 'ATTENDED' | 'NOT_ATTENDED';
-export interface GetAttendanceRequest {
+type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_SET' | 'ATTENDED' | 'NOT_ATTENDED';
+interface GetAttendanceRequest {
     /**
      * ID of the attendance object to retrieve.
      * @format GUID
      */
     attendanceId: string;
 }
-export interface GetAttendanceResponse {
+interface GetAttendanceResponse {
     /** Retrieved attendance. */
     attendance?: Attendance;
 }
-export interface SetAttendanceRequest {
+interface SetAttendanceRequest {
     /** Attendance to create or update. */
     attendance: Attendance;
     /** Information about whether to send a message to a customer after their attendance was set. */
     participantNotification?: ParticipantNotification;
 }
-export interface ParticipantNotification {
+interface ParticipantNotification {
     /**
      * Specify whether to send the message about the changes to the customer.
      *
@@ -78,17 +78,17 @@ export interface ParticipantNotification {
      */
     message?: string | null;
 }
-export interface SetAttendanceResponse {
+interface SetAttendanceResponse {
     /** Created or updated attendance. */
     attendance?: Attendance;
 }
-export interface AttendanceMarkedAsNotAttended {
+interface AttendanceMarkedAsNotAttended {
     /** The attendance information for a booked session that you want to create or update. */
     attendance?: Attendance;
     /** Information about whether to send a message to a customer after their attendance was set. */
     participantNotification?: ParticipantNotification;
 }
-export interface BulkSetAttendanceRequest {
+interface BulkSetAttendanceRequest {
     returnFullEntity?: boolean;
     /**
      * List of attendance details for booking sessions to create or update.
@@ -96,13 +96,13 @@ export interface BulkSetAttendanceRequest {
      */
     attendanceDetails?: AttendanceDetails[];
 }
-export interface AttendanceDetails {
+interface AttendanceDetails {
     /** Created or updated attendance information for a booking session. */
     attendance?: Attendance;
     /** Information about whether to send a message to the customer after their attendance was set. */
     participantNotification?: ParticipantNotification;
 }
-export interface BulkSetAttendanceResponse {
+interface BulkSetAttendanceResponse {
     /**
      * List of created or updated `attendance` objects.
      * @minSize 1
@@ -112,15 +112,15 @@ export interface BulkSetAttendanceResponse {
     /** Information about the total number of successes and failures for the Bulk Set Attendance call. */
     bulkActionMetadata?: BulkActionMetadata;
 }
-export interface BulkAttendanceResult {
+interface BulkAttendanceResult {
     /** Created or updated `attendance` object. */
     item?: Attendance;
     /** Metadata for the created or updated `attendance` object. */
     itemMetadata?: ItemMetadata;
 }
-export interface ItemMetadata {
+interface ItemMetadata {
     /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
+    _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
     /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
@@ -128,7 +128,7 @@ export interface ItemMetadata {
     /** Details about the error in case of failure. */
     error?: ApplicationError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -136,7 +136,7 @@ export interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-export interface BulkActionMetadata {
+interface BulkActionMetadata {
     /** Number of items that were successfully processed. */
     totalSuccesses?: number;
     /** Number of items that couldn't be processed. */
@@ -144,11 +144,11 @@ export interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
-export interface QueryAttendanceRequest {
+interface QueryAttendanceRequest {
     /** Query options. */
     query: QueryV2;
 }
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
+interface QueryV2 extends QueryV2PagingMethodOneOf {
     /**
      * Cursor token pointing to a page of results. In the first request,
      * specify `cursorPaging.limit`. For following requests, specify the
@@ -173,7 +173,7 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface QueryV2PagingMethodOneOf {
+interface QueryV2PagingMethodOneOf {
     /**
      * Cursor token pointing to a page of results. In the first request,
      * specify `cursorPaging.limit`. For following requests, specify the
@@ -182,7 +182,7 @@ export interface QueryV2PagingMethodOneOf {
      */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /** Name of the field to sort by. */
     fieldName?: string;
     /** Sort order. */
@@ -193,19 +193,19 @@ export interface Sorting {
  *
  * Default: `ASC`.
  */
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface Paging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Number of `Attendance` objects to return.
      *
@@ -225,14 +225,14 @@ export interface CursorPaging {
     cursor?: string | null;
 }
 /** List of objects that contain attendance information. */
-export interface QueryAttendanceResponse {
+interface QueryAttendanceResponse {
     /** List of `attendance` objects that contain attendance information for a booked session. */
     attendances?: Attendance[];
     /** Metadata for the paged set of results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 /** This is the preferred message for cursor-paging enabled services */
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** 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;
     /**
@@ -242,19 +242,19 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /** Cursor pointing to next page in the list of results. */
     next?: string | null;
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
+    _id?: string;
     /**
      * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
      * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
@@ -283,36 +283,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+interface EntityCreatedEvent {
+    entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
-    currentEntityAsJson?: string;
+    currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
+    deletedEntity?: string | null;
 }
-export interface ActionEvent {
-    bodyAsJson?: string;
+interface ActionEvent {
+    body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -328,7 +326,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -353,7 +351,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -375,7 +373,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -383,4 +381,83 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface SetAttendanceOptions {
+    /** Information about whether to send a message to a customer after their attendance was set. */
+    participantNotification?: ParticipantNotification;
+}
+interface BulkSetAttendanceOptions {
+    returnFullEntity?: boolean;
+    /**
+     * List of attendance details for booking sessions to create or update.
+     * @maxSize 8
+     */
+    attendanceDetails?: AttendanceDetails[];
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface AttendancesQueryResult extends QueryCursorResult {
+    items: Attendance[];
+    query: AttendancesQueryBuilder;
+    next: () => Promise<AttendancesQueryResult>;
+    prev: () => Promise<AttendancesQueryResult>;
+}
+interface AttendancesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees', value: any) => AttendancesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | 'bookingId' | 'sessionId' | 'status' | 'numberOfAttendees'>) => AttendancesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'numberOfAttendees'>) => AttendancesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => AttendancesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => AttendancesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<AttendancesQueryResult>;
+}
+
+export { type Attendance as A, type BulkSetAttendanceOptions as B, type CursorPaging as C, type DomainEvent as D, type EntityCreatedEvent as E, type AttendancesQueryResult as F, type GetAttendanceRequest as G, type ItemMetadata as I, type MessageEnvelope as M, type ParticipantNotification as P, type QueryAttendanceRequest as Q, type RestoreInfo as R, type SetAttendanceOptions as S, WebhookIdentityType as W, type SetAttendanceResponse as a, type BulkSetAttendanceResponse as b, type AttendancesQueryBuilder as c, AttendanceStatus as d, SortOrder as e, type GetAttendanceResponse as f, type SetAttendanceRequest as g, type AttendanceMarkedAsNotAttended as h, type BulkSetAttendanceRequest as i, type AttendanceDetails as j, type BulkAttendanceResult as k, type ApplicationError as l, type BulkActionMetadata as m, type QueryV2 as n, type QueryV2PagingMethodOneOf as o, type Sorting as p, type Paging as q, type QueryAttendanceResponse as r, type CursorPagingMetadata as s, type Cursors as t, type DomainEventBodyOneOf as u, type EntityUpdatedEvent as v, type EntityDeletedEvent as w, type ActionEvent as x, type IdentificationData as y, type IdentificationDataIdOneOf as z };