@wix/auto_sdk_calendar_participations 1.0.40 → 1.0.42

package/build/cjs/calendar-v3-participation-participations.universal-CRcW0LBD.d.ts

@@ -0,0 +1,1599 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * The `participation` object represents the relationship between a participant and
+ * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+ * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
+ * It includes details about the participant, whether the participation status is confirmed or
+ * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
+ */
+interface Participation extends ParticipationParticipatedItemOneOf {
+    /**
+     * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * associated with the participation.
+     * @format GUID
+     * @immutable
+     */
+    scheduleId?: string | null;
+    /**
+     * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * associated with the participation.
+     * @minLength 36
+     * @maxLength 250
+     * @immutable
+     */
+    eventId?: string | null;
+    /**
+     * Participation ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * External ID.
+     * @format GUID
+     * @immutable
+     */
+    externalId?: string | null;
+    /** Information about the participant. */
+    participant?: Participant;
+    /**
+     * Party size of the group or `1` for individuals.
+     *
+     * Min: `1`
+     * Max: `1000`
+     * @min 1
+     * @max 1000
+     */
+    partySize?: number | null;
+    /**
+     * Status of the party's participation in the event. Depending on your
+     * implementation, confirmation may be handled by the business owner or the customer.
+     *
+     * Supported values:
+     * + `CONFIRMED`: The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
+     * + `PENDING_CONFIRMATION`: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
+     *
+     * Default: `CONFIRMED`
+     */
+    status?: StatusWithLiterals;
+    /**
+     * ID of the app that owns the participation `object`. Identical to `appId` of the
+     * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * that the related
+     * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * belongs to.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the participation is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the participation.
+     * Ignored when creating a participation.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Extensions enabling applications or users to save custom data related to the participation. */
+    extendedFields?: ExtendedFields;
+}
+/** @oneof */
+interface ParticipationParticipatedItemOneOf {
+    /**
+     * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * associated with the participation.
+     * @format GUID
+     * @immutable
+     */
+    scheduleId?: string | null;
+    /**
+     * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * associated with the participation.
+     * @minLength 36
+     * @maxLength 250
+     * @immutable
+     */
+    eventId?: string | null;
+}
+interface Participant {
+    /**
+     * Participant name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     * @minLength 1
+     * @maxLength 200
+     */
+    name?: string | null;
+    /**
+     * Participant's phone number.
+     * @format PHONE
+     */
+    phone?: string | null;
+    /**
+     * Participant's email address.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /**
+     * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
+     * ID of the participant.
+     * @format GUID
+     */
+    contactId?: string | null;
+}
+declare enum Status {
+    /** The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
+    CONFIRMED = "CONFIRMED",
+    /** The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
+    PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'CONFIRMED' | 'PENDING_CONFIRMATION';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface GetParticipationRequest {
+    /**
+     * ID of the `participation` object to retrieve.
+     * @format GUID
+     */
+    participationId: string | null;
+}
+interface GetParticipationResponse {
+    /** Retrieved `participation` object. */
+    participation?: Participation;
+}
+interface QueryParticipationsRequest {
+    /** Query containing filters and paging. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Number of participations to load.
+     * @min 1
+     * @max 100
+     */
+    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;
+}
+interface QueryParticipationsResponse {
+    /** Retrieved `participation` objects matching the provided query. */
+    participations?: Participation[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    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;
+}
+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;
+}
+interface SearchParticipationsRequest {
+    /** Search criteria including filter, sort, aggregations, and free-text search. */
+    search: CursorSearch;
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CommonCursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /**
+     * Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
+     * @maxSize 10
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+    /**
+     * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
+     * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CommonCursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Aggregation extends AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
+    nested?: NestedAggregation;
+    /**
+     * Aggregation name, returned in `aggregations.results.name`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation to perform. Must align with the corresponding aggregation field. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+    /**
+     * Deprecated. Use `nested` instead.
+     * @deprecated Deprecated. Use `nested` instead.
+     * @replacedBy kind.nested
+     * @targetRemovalDate 2024-03-30
+     */
+    groupBy?: GroupByAggregation;
+}
+/** @oneof */
+interface AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
+    nested?: NestedAggregation;
+}
+interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
+    to?: number | null;
+}
+declare enum SortType {
+    /** Number of matches in the results. */
+    COUNT = "COUNT",
+    /** Alphabetically by the field value. */
+    VALUE = "VALUE"
+}
+/** @enumType */
+type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
+declare enum SortDirection {
+    /** Descending order. */
+    DESC = "DESC",
+    /** Ascending order. */
+    ASC = "ASC"
+}
+/** @enumType */
+type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
+declare enum MissingValues {
+    /** Exclude missing values from the aggregation results. */
+    EXCLUDE = "EXCLUDE",
+    /** Include missing values in the aggregation results. */
+    INCLUDE = "INCLUDE"
+}
+/** @enumType */
+type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
+interface IncludeMissingValuesOptions {
+    /**
+     * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
+     * @maxLength 20
+     */
+    addToBucket?: string;
+}
+declare enum ScalarType {
+    /** Total number of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX"
+}
+/** @enumType */
+type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
+interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Sort type. */
+    sortType?: SortTypeWithLiterals;
+    /** Sort direction. */
+    sortDirection?: SortDirectionWithLiterals;
+    /**
+     * Number of aggregation results to return.
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
+    limit?: number | null;
+    /**
+     * Whether to include or exclude missing values in the aggregation results.
+     * Default: `EXCLUDE`.
+     */
+    missingValues?: MissingValuesWithLiterals;
+}
+/** @oneof */
+interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+declare enum NestedAggregationType {
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
+    VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
+    RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+/** @enumType */
+type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
+interface RangeAggregation {
+    /**
+     * List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
+     * @maxSize 50
+     */
+    buckets?: RangeBucket[];
+}
+interface ScalarAggregation {
+    /** Operator type for the scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+}
+interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation. */
+    interval?: IntervalWithLiterals;
+}
+declare enum Interval {
+    YEAR = "YEAR",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    DAY = "DAY",
+    HOUR = "HOUR",
+    MINUTE = "MINUTE",
+    SECOND = "SECOND"
+}
+/** @enumType */
+type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
+interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation to perform. The matching aggregation field must be passed. */
+    type?: NestedAggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    dateHistogram?: DateHistogramAggregation;
+}
+declare enum AggregationType {
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
+    VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
+    RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
+    NESTED = "NESTED"
+}
+/** @enumType */
+type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
+interface NestedAggregation {
+    /**
+     * Flattened list of aggregations, where each aggregation is nested within previous one.
+     * @minSize 2
+     * @maxSize 3
+     */
+    nestedAggregations?: NestedAggregationItem[];
+}
+interface GroupByAggregation extends GroupByAggregationKindOneOf {
+    /** Value aggregation configuration. */
+    value?: ValueAggregation;
+    /**
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * Field to aggregate by.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface GroupByAggregationKindOneOf {
+    /** Value aggregation configuration. */
+    value?: ValueAggregation;
+}
+interface SearchDetails {
+    /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** At least one of the search terms must be present. */
+    OR = "OR",
+    /** All search terms must be present. */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+interface CommonCursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface SearchParticipationsResponse {
+    /** Retrieved `participation` objects matching the provided search. */
+    participations?: Participation[];
+    /** Cursor-based paging metadata. */
+    pagingMetadata?: CommonCursorPagingMetadata;
+    /** Aggregation results. */
+    aggregationData?: AggregationData;
+}
+interface CommonCursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: CommonCursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface CommonCursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface AggregationData {
+    /**
+     * List of the aggregated data results.
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Number of entities with this value. */
+    count?: number;
+}
+interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Total number of entities in this range. */
+    count?: number;
+}
+interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /**
+     * Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Aggregation type. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field which the data was aggregated by.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+}
+interface ValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+interface RangeResults {
+    /**
+     * List of ranges returned in the same order as requested.
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Nested aggregations. */
+    nestedResults?: NestedAggregationResults;
+}
+interface ValueResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Number of entities with this value. */
+    count?: number | null;
+}
+interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Number of entities in this range. */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface ScalarDateResult {
+    /**
+     * Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     * @maxLength 100
+     */
+    value?: string;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+    /** Scalar date aggregation result. */
+    scalarDate?: ScalarDateResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+    /** Scalar date aggregation result. */
+    scalarDate?: ScalarDateResult;
+}
+interface Results {
+    /** List of nested aggregations. */
+    results?: Record<string, NestedResultValue>;
+}
+interface DateHistogramResult {
+    /**
+     * Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Number of entities in the bucket. */
+    count?: number;
+}
+interface GroupByValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 1000
+     */
+    results?: NestedValueAggregationResult[];
+}
+interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations.
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/** Results of `NESTED` aggregation type in a flattened array, identifiable by the requested aggregation `name`. */
+interface NestedResults {
+    /**
+     * List of nested aggregations.
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+interface AggregationResultsScalarDateResult {
+    /** Type of scalar date aggregation. Possible values: `MIN`, `MAX`. */
+    type?: ScalarTypeWithLiterals;
+    /**
+     * Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     * @maxLength 100
+     */
+    value?: string;
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /** Date aggregation results. */
+    scalarDate?: AggregationResultsScalarDateResult;
+    /**
+     * Aggregation name, returned in `aggregations.results.name`.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Aggregation type. Must align with the corresponding aggregation field. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /** Date aggregation results. */
+    scalarDate?: AggregationResultsScalarDateResult;
+}
+interface CreateParticipationRequest {
+    /** `participation` object to create. */
+    participation: Participation;
+    /**
+     * Idempotency key guaranteeing that you don't create the same `participation`
+     * object more than once.
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+interface CreateParticipationResponse {
+    /** Created `participation` object. */
+    participation?: Participation;
+}
+interface UpdateParticipationRequest {
+    /** `participation` object to update. */
+    participation: Participation;
+}
+interface UpdateParticipationResponse {
+    /** Updated `participation` object. */
+    participation?: Participation;
+}
+interface DeleteParticipationRequest {
+    /**
+     * ID of `participation` object to delete.
+     * @format GUID
+     */
+    participationId: string | null;
+}
+interface DeleteParticipationResponse {
+}
+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;
+    /**
+     * 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`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface SumParticipationsPartySizeByScheduleIdRequest {
+    /**
+     * The schedule IDs.
+     * @format GUID
+     * @maxSize 100
+     */
+    scheduleIds?: string[] | null;
+}
+interface SumParticipationsPartySizeByScheduleIdResponse {
+    /** The sum of party size by schedule ID. */
+    partySizeSumByScheduleId?: PartySizeSumByScheduleId[];
+}
+interface PartySizeSumByScheduleId {
+    /**
+     * The ID of the schedule.
+     * @format GUID
+     */
+    scheduleId?: string | null;
+    /** The sum of the participations party size. */
+    partySizeSum?: number | null;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _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`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface ParticipationCreatedEnvelope {
+    entity: Participation;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a `participation` object is created.
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionId CALENDAR.PARTICIPATION_READ
+ * @webhook
+ * @eventType wix.calendar.v3.participation_created
+ * @slug created
+ */
+declare function onParticipationCreated(handler: (event: ParticipationCreatedEnvelope) => void | Promise<void>): void;
+interface ParticipationDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a `participation` object is deleted.
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionId CALENDAR.PARTICIPATION_READ
+ * @webhook
+ * @eventType wix.calendar.v3.participation_deleted
+ * @slug deleted
+ */
+declare function onParticipationDeleted(handler: (event: ParticipationDeletedEnvelope) => void | Promise<void>): void;
+interface ParticipationUpdatedEnvelope {
+    entity: Participation;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a `participation` object is updated.
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionId CALENDAR.PARTICIPATION_READ
+ * @webhook
+ * @eventType wix.calendar.v3.participation_updated
+ * @slug updated
+ */
+declare function onParticipationUpdated(handler: (event: ParticipationUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves a `participation` object.
+ * @param participationId - ID of the `participation` object to retrieve.
+ * @public
+ * @requiredField participationId
+ * @permissionId CALENDAR.PARTICIPATION_READ
+ * @applicableIdentity APP
+ * @returns Retrieved `participation` object.
+ * @fqn wix.calendar.participations.v3.ParticipationsService.GetParticipation
+ */
+declare function getParticipation(participationId: string): Promise<NonNullablePaths<Participation, `status`, 2>>;
+/**
+ * Creates a query to retrieve a list of participations.
+ *
+ * The `queryParticipations()` function builds a query to retrieve a list of participations and returns a `ParticipationsQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/participations/participations-query-builder/find) function.
+ *
+ * You can refine the query by chaining `ParticipationsQueryBuilder` functions onto the query. `ParticipationsQueryBuilder` functions enable you to sort, filter, and control the results that `queryParticipations()` returns.
+ *
+ * `queryParticipations()` runs with the following `ParticipationsQueryBuilder` default that you can override:
+ *
+ * + `limit` is `50`.
+ * + Sorted by `createdDate` in ascending order.
+ *
+ * The functions that are chained to `queryParticipations()` are applied in the order they are called.
+ *
+ * The following `ParticipationsQueryBuilder` functions are supported for the `queryParticipations()` function. For a full description of the participations object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/participations/participations-query-result/items) property in `ParticipationsQueryResult`.
+ *
+ * @public
+ * @permissionId CALENDAR.PARTICIPATION_READ
+ * @applicableIdentity APP
+ * @fqn wix.calendar.participations.v3.ParticipationsService.QueryParticipations
+ */
+declare function queryParticipations(): ParticipationsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ParticipationsQueryResult extends QueryCursorResult {
+    items: Participation[];
+    query: ParticipationsQueryBuilder;
+    next: () => Promise<ParticipationsQueryResult>;
+    prev: () => Promise<ParticipationsQueryResult>;
+}
+interface ParticipationsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: 'scheduleId' | 'eventId' | 'externalId' | 'participant.contactId' | 'partySize' | 'status' | 'appId' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: 'partySize' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: 'partySize' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: 'partySize' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: 'partySize' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: 'partySize' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: '_createdDate' | '_updatedDate', value: any[]) => ParticipationsQueryBuilder;
+    in: (propertyName: 'scheduleId' | 'eventId' | '_id' | 'externalId' | 'participant.contactId' | 'status' | 'appId' | '_createdDate' | '_updatedDate', value: any) => ParticipationsQueryBuilder;
+    exists: (propertyName: '_createdDate' | '_updatedDate', value: boolean) => ParticipationsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => ParticipationsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: Array<'_createdDate' | '_updatedDate'>) => ParticipationsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => ParticipationsQueryBuilder;
+    /** @param cursor - A pointer to specific record */
+    skipTo: (cursor: string) => ParticipationsQueryBuilder;
+    find: () => Promise<ParticipationsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.calendar.participations.v3.ParticipationsService.QueryParticipations
+ * @requiredField query
+ */
+declare function typedQueryParticipations(query: ParticipationQuery): Promise<NonNullablePaths<QueryParticipationsResponse, `participations` | `participations.${number}.status`, 4>>;
+interface ParticipationQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id'];
+            operators: ['$in'];
+            sort: 'NONE';
+        },
+        {
+            fields: [
+                'appId',
+                'eventId',
+                'externalId',
+                'participant.contactId',
+                'scheduleId',
+                'status'
+            ];
+            operators: ['$eq', '$in'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['partySize'];
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['_createdDate', '_updatedDate'];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Participation, ParticipationQuerySpec>;
+type ParticipationQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Number of participations to load.
+      @min: 1,
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Participation, ParticipationQuerySpec, ParticipationQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Participation, ParticipationQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<ParticipationQuerySpec>;
+    };
+    search: {
+        SearchBuilder: () => _wix_sdk_types.SearchBuilder<Participation, ParticipationSearchSpec, ParticipationSearch>;
+        Filter: _wix_sdk_types.FilterFactory<Participation, ParticipationSearchSpec>;
+        Sort: _wix_sdk_types.SortFactory<ParticipationSearchSpec>;
+        SearchParams: _wix_sdk_types.SearchParamsFactory<ParticipationSearchSpec>;
+        Aggregation: _wix_sdk_types.AggregationFactory<ParticipationSearchSpec>;
+    };
+};
+interface ParticipationSearchSpec extends SearchSpec {
+    aggregatable: [
+        '_createdDate',
+        '_id',
+        '_updatedDate',
+        'appId',
+        'eventId',
+        'externalId',
+        'participant.contactId',
+        'partySize',
+        'scheduleId',
+        'status'
+    ];
+    paging: 'cursor';
+    wql: [
+        {
+            operators: ['$in'];
+            fields: ['_id'];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$eq', '$in'];
+            fields: [
+                'appId',
+                'eventId',
+                'externalId',
+                'participant.contactId',
+                'scheduleId',
+                'status'
+            ];
+            sort: 'NONE';
+        },
+        {
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            fields: ['partySize'];
+            sort: 'NONE';
+        },
+        {
+            operators: '*';
+            fields: ['_createdDate', '_updatedDate'];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonSearchWithEntityContext = Search<Participation, ParticipationSearchSpec>;
+type ParticipationSearch = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonSearchWithEntityContext['filter'] | null;
+    /**
+    List of sort objects.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
+    }[];
+    /**
+    Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
+    @maxSize: 10
+    */
+    aggregations?: {
+        /**
+      A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store.
+      */
+        value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
+        /**
+      A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more.
+      */
+        range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
+        /**
+      A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
+      */
+        scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
+        /**
+      A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week.
+      */
+        dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
+        /**
+      A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+      */
+        nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
+        /**
+      Aggregation name, returned in `aggregations.results.name`.
+      @maxLength: 100
+      */
+        name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
+        /**
+      Type of aggregation to perform. Must align with the corresponding aggregation field.
+      */
+        type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
+        /**
+      Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+      @maxLength: 200
+      */
+        fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
+        /**
+      Deprecated. Use `nested` instead.
+      @deprecated: Deprecated. Use `nested` instead.,
+      @replacedBy: kind.nested,
+      @targetRemovalDate: 2024-03-30
+      */
+        groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
+    }[];
+    /**
+    Free text to match in searchable fields.
+    */
+    search?: {
+        /**
+      Search mode. Defines the search logic for combining multiple terms in the `expression`.
+      */
+        mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
+        /**
+      Search term or expression.
+      @maxLength: 100
+      */
+        expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
+        /**
+      Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+      @maxLength: 200,
+      @maxSize: 20
+      */
+        fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
+        /**
+      Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions.
+      */
+        fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
+    };
+    /**
+    Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
+    Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
+    @maxLength: 50
+    */
+    timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
+};
+/**
+ * Creates a `participation` object for a schedule or event.
+ * @param participation - `participation` object to create.
+ * @public
+ * @requiredField participation
+ * @requiredField participation.participant
+ * @requiredField participation.participant.name
+ * @requiredField participation.participatedItem
+ * @requiredField participation.partySize
+ * @permissionId CALENDAR.PARTICIPATION_CREATE
+ * @applicableIdentity APP
+ * @returns Created `participation` object.
+ * @fqn wix.calendar.participations.v3.ParticipationsService.CreateParticipation
+ */
+declare function createParticipation(participation: NonNullablePaths<Participation, `participant` | `participant.name` | `partySize`, 3>, options?: CreateParticipationOptions): Promise<NonNullablePaths<Participation, `status`, 2>>;
+interface CreateParticipationOptions {
+    /**
+     * Idempotency key guaranteeing that you don't create the same `participation`
+     * object more than once.
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+/**
+ * Updates a `participation` object.
+ * @param _id - Participation ID.
+ * @public
+ * @requiredField _id
+ * @requiredField participation
+ * @requiredField participation.revision
+ * @permissionId CALENDAR.PARTICIPATION_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated `participation` object.
+ * @fqn wix.calendar.participations.v3.ParticipationsService.UpdateParticipation
+ */
+declare function updateParticipation(_id: string, participation: NonNullablePaths<UpdateParticipation, `revision`, 2>): Promise<NonNullablePaths<Participation, `status`, 2>>;
+interface UpdateParticipation {
+    /**
+     * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * associated with the participation.
+     * @format GUID
+     * @immutable
+     */
+    scheduleId?: string | null;
+    /**
+     * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * associated with the participation.
+     * @minLength 36
+     * @maxLength 250
+     * @immutable
+     */
+    eventId?: string | null;
+    /**
+     * Participation ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * External ID.
+     * @format GUID
+     * @immutable
+     */
+    externalId?: string | null;
+    /** Information about the participant. */
+    participant?: Participant;
+    /**
+     * Party size of the group or `1` for individuals.
+     *
+     * Min: `1`
+     * Max: `1000`
+     * @min 1
+     * @max 1000
+     */
+    partySize?: number | null;
+    /**
+     * Status of the party's participation in the event. Depending on your
+     * implementation, confirmation may be handled by the business owner or the customer.
+     *
+     * Supported values:
+     * + `CONFIRMED`: The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
+     * + `PENDING_CONFIRMATION`: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
+     *
+     * Default: `CONFIRMED`
+     */
+    status?: StatusWithLiterals;
+    /**
+     * ID of the app that owns the participation `object`. Identical to `appId` of the
+     * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * that the related
+     * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * belongs to.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the participation is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the participation.
+     * Ignored when creating a participation.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Extensions enabling applications or users to save custom data related to the participation. */
+    extendedFields?: ExtendedFields;
+}
+/**
+ * Deletes a `participation` object.
+ * @param participationId - ID of `participation` object to delete.
+ * @public
+ * @requiredField participationId
+ * @permissionId CALENDAR.PARTICIPATION_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.calendar.participations.v3.ParticipationsService.DeleteParticipation
+ */
+declare function deleteParticipation(participationId: string): Promise<void>;
+
+export { type CommonCursorPagingMetadata as $, AggregationType as A, type IncludeMissingValuesOptions as B, type CreateParticipationOptions as C, type ValueAggregationOptionsOneOf as D, type ExtendedFields as E, type RangeAggregation as F, type GetParticipationRequest as G, type ScalarAggregation as H, Interval as I, type DateHistogramAggregation as J, type NestedAggregationItem as K, type NestedAggregationItemKindOneOf as L, MissingValues as M, NestedAggregationType as N, type NestedAggregation as O, type Participation as P, type QueryParticipationsRequest as Q, type RangeBucket as R, Status as S, type GroupByAggregation as T, type UpdateParticipation as U, type ValueAggregation as V, WebhookIdentityType as W, type GroupByAggregationKindOneOf as X, type SearchDetails as Y, type CommonCursorPaging as Z, type SearchParticipationsResponse as _, type ParticipationCreatedEnvelope as a, type CommonQueryWithEntityContext as a$, type CommonCursors as a0, type AggregationData as a1, type ValueAggregationResult as a2, type RangeAggregationResult as a3, type NestedAggregationResults as a4, type NestedAggregationResultsResultOneOf as a5, type ValueResults as a6, type RangeResults as a7, type AggregationResultsScalarResult as a8, type NestedValueAggregationResult as a9, type ActionEvent as aA, type Empty as aB, type SumParticipationsPartySizeByScheduleIdRequest as aC, type SumParticipationsPartySizeByScheduleIdResponse as aD, type PartySizeSumByScheduleId as aE, type MessageEnvelope as aF, type IdentificationData as aG, type IdentificationDataIdOneOf as aH, type AccountInfo as aI, type BaseEventMetadata as aJ, type EventMetadata as aK, type AccountInfoMetadata as aL, type ParticipationsQueryResult as aM, type ParticipationQuerySpec as aN, type ParticipationSearchSpec as aO, utils as aP, type StatusWithLiterals as aQ, type SortOrderWithLiterals as aR, type SortTypeWithLiterals as aS, type SortDirectionWithLiterals as aT, type MissingValuesWithLiterals as aU, type ScalarTypeWithLiterals as aV, type NestedAggregationTypeWithLiterals as aW, type IntervalWithLiterals as aX, type AggregationTypeWithLiterals as aY, type ModeWithLiterals as aZ, type WebhookIdentityTypeWithLiterals as a_, type ValueResult as aa, type RangeResult as ab, type ScalarResult as ac, type ScalarDateResult as ad, type NestedResultValue as ae, type NestedResultValueResultOneOf as af, type Results as ag, type DateHistogramResult as ah, type GroupByValueResults as ai, type DateHistogramResults as aj, type NestedResults as ak, type AggregationResultsScalarDateResult as al, type AggregationResults as am, type AggregationResultsResultOneOf as an, type CreateParticipationRequest as ao, type CreateParticipationResponse as ap, type UpdateParticipationRequest as aq, type UpdateParticipationResponse as ar, type DeleteParticipationRequest as as, type DeleteParticipationResponse as at, type DomainEvent as au, type DomainEventBodyOneOf as av, type EntityCreatedEvent as aw, type RestoreInfo as ax, type EntityUpdatedEvent as ay, type EntityDeletedEvent as az, type ParticipationDeletedEnvelope as b, type CommonSearchWithEntityContext as b0, type ParticipationSearch as b1, onParticipationCreated as b2, onParticipationDeleted as b3, onParticipationUpdated as b4, getParticipation as b5, queryParticipations as b6, createParticipation as b7, updateParticipation as b8, deleteParticipation as b9, type ParticipationUpdatedEnvelope as c, type ParticipationsQueryBuilder as d, type ParticipationQuery as e, SortOrder as f, SortType as g, SortDirection as h, ScalarType as i, Mode as j, type ParticipationParticipatedItemOneOf as k, type Participant as l, type GetParticipationResponse as m, type CursorQuery as n, type CursorQueryPagingMethodOneOf as o, type CursorPaging as p, type QueryParticipationsResponse as q, type CursorPagingMetadata as r, type Cursors as s, typedQueryParticipations as t, type SearchParticipationsRequest as u, type CursorSearch as v, type CursorSearchPagingMethodOneOf as w, type Sorting as x, type Aggregation as y, type AggregationKindOneOf as z };