@wix/bookings 1.0.343 → 1.0.345

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

@@ -1,496 +0,0 @@
-/**
- * The `Attendance` object represents the attendance information
- * for a booked session, such as:
- *
- * + Did anyone attend the session?
- * + How many people attended the session?
- *
- * The number of session `Attendance` objects available depends on the booking type:
- * + Appointment bookings have 1 `Attendance` object per appointment session.
- * + 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`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) 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`](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/schedule/schedule-object) property.
- */
-export interface Attendance {
-    /**
-     * ID of the `Attendance` object.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Corresponding booking ID. */
-    bookingId?: string | null;
-    /** Corresponding session ID. */
-    sessionId?: string | null;
-    /**
-     * Status indicating if any participants attended the session:
-     *
-     * + `NOT_SET`: There is no available attendance information.
-     * + `ATTENDED`: At least a single participant attended the session.
-     * + `NOT_ATTENDED`: No participants attended the session.
-     */
-    status?: AttendanceStatus;
-    /**
-     * 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 attended.
-     *
-     * 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 {
-    NOT_SET = "NOT_SET",
-    ATTENDED = "ATTENDED",
-    NOT_ATTENDED = "NOT_ATTENDED"
-}
-export interface GetAttendanceRequest {
-    /** ID of the object that contains the attendance information that you want to retrieve. */
-    attendanceId: string;
-}
-export interface GetAttendanceResponse {
-    /** The retrieved attendance information for the booked session. */
-    attendance?: Attendance;
-}
-export interface SetAttendanceRequest {
-    /** The attendance information for a booked session that you want to create or update. */
-    attendance: Attendance;
-}
-export interface SetAttendanceResponse {
-    /** The created or updated attendance information for the booked session. */
-    attendance?: Attendance;
-}
-export interface BulkSetAttendanceRequest {
-    /** The attendance information for a booked sessions that you want to create or update. */
-    attendanceList: Attendance[];
-    returnFullEntity?: boolean;
-}
-export interface BulkSetAttendanceResponse {
-    /** The created or updated attendance information for the booked sessions. */
-    results?: BulkAttendanceResult[];
-    /** Total successes and failures of the bulk set attendance action. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkAttendanceResult {
-    item?: Attendance;
-    itemMetadata?: ItemMetadata;
-}
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _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. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-export interface QueryAttendanceRequest {
-    /** 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/supported-filters).
-     *
-     * 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/supported-filters).
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Cursors to navigate through the result pages using `next` and `prev`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** 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"
-}
-export 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 {
-    /**
-     * 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 {
-    /** List of objects that contain attendance information for a booked session. */
-    attendances?: Attendance[];
-    /** 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 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.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     */
-    hasNext?: boolean | null;
-}
-export 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<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    _id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
-     */
-    entityEventSequence?: string | null;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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.
-     */
-    currentEntity?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface GetAttendanceResponseNonNullableFields {
-    attendance?: {
-        status: AttendanceStatus;
-        numberOfAttendees: number;
-    };
-}
-export interface SetAttendanceResponseNonNullableFields {
-    attendance?: {
-        status: AttendanceStatus;
-        numberOfAttendees: number;
-    };
-}
-export interface BulkSetAttendanceResponseNonNullableFields {
-    results: {
-        item?: {
-            status: AttendanceStatus;
-            numberOfAttendees: number;
-        };
-        itemMetadata?: {
-            originalIndex: number;
-            success: boolean;
-            error?: {
-                code: string;
-                description: string;
-            };
-        };
-    }[];
-    bulkActionMetadata?: {
-        totalSuccesses: number;
-        totalFailures: number;
-        undetailedFailures: number;
-    };
-}
-export interface QueryAttendanceResponseNonNullableFields {
-    attendances: {
-        status: AttendanceStatus;
-        numberOfAttendees: number;
-    }[];
-}
-/**
- * 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 Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Read Bookings - Including Participants
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
- * @permissionScope Read Bookings - all read permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns The retrieved attendance information for the booked session.
- */
-export declare function getAttendance(attendanceId: string): Promise<Attendance & NonNullable<GetAttendanceResponseNonNullableFields>['attendance']>;
-/**
- * Sets information about whether a booking's session was attended. This information
- * is saved in an `Attendance` object.
- *
- *
- * 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 attended. 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
- * @requiredField attendance.bookingId
- * @requiredField attendance.status
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- */
-export declare function setAttendance(attendance: Attendance): Promise<SetAttendanceResponse & SetAttendanceResponseNonNullableFields>;
-/**
- * Sets information about whether a booking's session was attended for multiple bookings
- *
- *
- * See [SetAttendance](https://dev.wix.com/docs/rest/api-reference/wix-bookings/attendance/set-attendance) documentation for more information.
- *
- * If any of the attendance list required fields were not passed on the request or if the caller doesn't have the required permissions to set the attendance, the call fails.
- * If the request contains attendance info for unavailable sessions, the call completes successfully but the attendance info for the unavailable sessions are not created and are not considered as failures in the response.
- * @param attendanceList - The attendance information for a booked sessions that you want to create or update.
- * @public
- * @documentationMaturity preview
- * @requiredField attendanceList
- * @requiredField attendanceList.bookingId
- * @requiredField attendanceList.status
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- */
-export declare function bulkSetAttendance(attendanceList: Attendance[], options?: BulkSetAttendanceOptions): Promise<BulkSetAttendanceResponse & BulkSetAttendanceResponseNonNullableFields>;
-export interface BulkSetAttendanceOptions {
-    returnFullEntity?: boolean;
-}
-/**
- * Retrieves attendance information for booked sessions, given the provided paging, filtering, and sorting.
- *
- *
- * 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 the attendance of a given participant in a course. For example, this query
- * helps you determine if a participant booked the course
- * but did not attend most of its sessions, taking away spots for other potential participants.
- *
- * 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/attendance/supported-filters).
- *
- * > __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` as `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).
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Read Bookings - Including Participants
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
- * @permissionScope Read Bookings - all read permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function queryAttendance(): AttendancesQueryBuilder;
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface AttendancesQueryResult extends QueryCursorResult {
-    items: Attendance[];
-    query: AttendancesQueryBuilder;
-    next: () => Promise<AttendancesQueryResult>;
-    prev: () => Promise<AttendancesQueryResult>;
-}
-export 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 {};