@wix/auto_sdk_calendar_participations 1.0.16 → 1.0.18

package/build/{internal/cjs/src/calendar-v3-participation-participations.universal.d.ts → calendar-v3-participation-participations.universal-Utp3ht5A.d.mts}

@@ -1,4 +1,3 @@
-import { 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)
@@ -6,7 +5,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * 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.
  */
-export interface Participation extends ParticipationParticipatedItemOneOf {
+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.
@@ -87,7 +86,7 @@ export interface Participation extends ParticipationParticipatedItemOneOf {
     extendedFields?: ExtendedFields;
 }
 /** @oneof */
-export interface ParticipationParticipatedItemOneOf {
+interface ParticipationParticipatedItemOneOf {
     /**
      * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
      * associated with the participation.
@@ -104,7 +103,7 @@ export interface ParticipationParticipatedItemOneOf {
      */
     eventId?: string | null;
 }
-export interface Participant {
+interface Participant {
     /**
      * Participant name.
      *
@@ -131,15 +130,15 @@ export interface Participant {
      */
     contactId?: string | null;
 }
-export declare enum Status {
+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 */
-export type StatusWithLiterals = Status | 'CONFIRMED' | 'PENDING_CONFIRMATION';
-export interface ExtendedFields {
+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.
@@ -150,22 +149,22 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface GetParticipationRequest {
+interface GetParticipationRequest {
     /**
      * ID of the `participation` object to retrieve.
      * @format GUID
      */
     participationId: string | null;
 }
-export interface GetParticipationResponse {
+interface GetParticipationResponse {
     /** Retrieved `participation` object. */
     participation?: Participation;
 }
-export interface QueryParticipationsRequest {
+interface QueryParticipationsRequest {
     /** Query containing filters and paging. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -179,11 +178,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     filter?: Record<string, any> | null;
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Number of participations to load.
      * @min 1
@@ -199,13 +198,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryParticipationsResponse {
+interface QueryParticipationsResponse {
     /** Retrieved `participation` objects matching the provided query. */
     participations?: Participation[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -217,13 +216,13 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /** Cursor pointing to next page in the list of results. */
     next?: string | null;
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
-export interface CreateParticipationRequest {
+interface CreateParticipationRequest {
     /** `participation` object to create. */
     participation: Participation;
     /**
@@ -233,28 +232,28 @@ export interface CreateParticipationRequest {
      */
     idempotencyKey?: string | null;
 }
-export interface CreateParticipationResponse {
+interface CreateParticipationResponse {
     /** Created `participation` object. */
     participation?: Participation;
 }
-export interface UpdateParticipationRequest {
+interface UpdateParticipationRequest {
     /** `participation` object to update. */
     participation: Participation;
 }
-export interface UpdateParticipationResponse {
+interface UpdateParticipationResponse {
     /** Updated `participation` object. */
     participation?: Participation;
 }
-export interface DeleteParticipationRequest {
+interface DeleteParticipationRequest {
     /**
      * ID of `participation` object to delete.
      * @format GUID
      */
     participationId: string | null;
 }
-export interface DeleteParticipationResponse {
+interface DeleteParticipationResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -289,19 +288,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -309,16 +308,16 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface SumParticipationsPartySizeByScheduleIdRequest {
+interface SumParticipationsPartySizeByScheduleIdRequest {
     /**
      * The schedule IDs.
      * @format GUID
@@ -326,11 +325,11 @@ export interface SumParticipationsPartySizeByScheduleIdRequest {
      */
     scheduleIds?: string[] | null;
 }
-export interface SumParticipationsPartySizeByScheduleIdResponse {
+interface SumParticipationsPartySizeByScheduleIdResponse {
     /** The sum of party size by schedule ID. */
     partySizeSumByScheduleId?: PartySizeSumByScheduleId[];
 }
-export interface PartySizeSumByScheduleId {
+interface PartySizeSumByScheduleId {
     /**
      * The ID of the schedule.
      * @format GUID
@@ -339,7 +338,7 @@ export interface PartySizeSumByScheduleId {
     /** The sum of the participations party size. */
     partySizeSum?: number | null;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -355,7 +354,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -380,7 +379,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -402,7 +401,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -410,8 +409,8 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -425,7 +424,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
@@ -455,107 +454,17 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface ParticipationCreatedEnvelope {
+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
- */
-export declare function onParticipationCreated(handler: (event: ParticipationCreatedEnvelope) => void | Promise<void>): void;
-export interface ParticipationDeletedEnvelope {
+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
- */
-export declare function onParticipationDeleted(handler: (event: ParticipationDeletedEnvelope) => void | Promise<void>): void;
-export interface ParticipationUpdatedEnvelope {
+interface ParticipationUpdatedEnvelope {
     entity: Participation;
     metadata: EventMetadata;
 }
-/**
- * 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
- */
-export declare function onParticipationUpdated(handler: (event: ParticipationUpdatedEnvelope) => void | Promise<void>): void;
-type ParticipationNonNullablePaths = `status`;
-/**
- * Retrieves a `participation` object.
- * @param participationId - ID of the `participation` object to retrieve.
- * @public
- * @requiredField participationId
- * @permissionId CALENDAR.PARTICIPATION_READ
- * @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
- * @applicableIdentity APP
- * @returns Retrieved `participation` object.
- * @fqn wix.calendar.participations.v3.ParticipationsService.GetParticipation
- */
-export declare function getParticipation(participationId: string): Promise<NonNullablePaths<Participation, ParticipationNonNullablePaths>>;
-/**
- * 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
- * @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
- * @applicableIdentity APP
- * @fqn wix.calendar.participations.v3.ParticipationsService.QueryParticipations
- */
-export declare function queryParticipations(): ParticipationsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -563,13 +472,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface ParticipationsQueryResult extends QueryCursorResult {
+interface ParticipationsQueryResult extends QueryCursorResult {
     items: Participation[];
     query: ParticipationsQueryBuilder;
     next: () => Promise<ParticipationsQueryResult>;
     prev: () => Promise<ParticipationsQueryResult>;
 }
-export interface ParticipationsQueryBuilder {
+interface ParticipationsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -581,28 +490,7 @@ export interface ParticipationsQueryBuilder {
     skipTo: (cursor: string) => ParticipationsQueryBuilder;
     find: () => Promise<ParticipationsQueryResult>;
 }
-/**
- * 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
- * @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
- * @applicableIdentity APP
- * @returns Created `participation` object.
- * @fqn wix.calendar.participations.v3.ParticipationsService.CreateParticipation
- */
-export declare function createParticipation(participation: NonNullablePaths<Participation, `participant` | `participant.name` | `partySize`>, options?: CreateParticipationOptions): Promise<NonNullablePaths<Participation, ParticipationNonNullablePaths>>;
-export interface CreateParticipationOptions {
+interface CreateParticipationOptions {
     /**
      * Idempotency key guaranteeing that you don't create the same `participation`
      * object more than once.
@@ -610,26 +498,7 @@ export interface CreateParticipationOptions {
      */
     idempotencyKey?: string | null;
 }
-/**
- * Updates a `participation` object.
- * @param _id - Participation ID.
- * @public
- * @requiredField _id
- * @requiredField participation
- * @requiredField participation.revision
- * @permissionId CALENDAR.PARTICIPATION_UPDATE
- * @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
- * @applicableIdentity APP
- * @returns Updated `participation` object.
- * @fqn wix.calendar.participations.v3.ParticipationsService.UpdateParticipation
- */
-export declare function updateParticipation(_id: string, participation: NonNullablePaths<UpdateParticipation, `revision`>): Promise<NonNullablePaths<Participation, ParticipationNonNullablePaths>>;
-export interface UpdateParticipation {
+interface UpdateParticipation {
     /**
      * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
      * associated with the participation.
@@ -709,20 +578,5 @@ export interface UpdateParticipation {
     /** 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
- * @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
- * @applicableIdentity APP
- * @fqn wix.calendar.participations.v3.ParticipationsService.DeleteParticipation
- */
-export declare function deleteParticipation(participationId: string): Promise<void>;
-export {};
+
+export { type ActionEvent as A, type PartySizeSumByScheduleId as B, type CreateParticipationOptions as C, type DeleteParticipationRequest as D, type ExtendedFields as E, type IdentificationDataIdOneOf as F, type GetParticipationRequest as G, type BaseEventMetadata as H, type IdentificationData as I, type EventMetadata as J, type ParticipationsQueryResult as K, type MessageEnvelope as M, type Participation as P, type QueryParticipationsRequest as Q, type RestoreInfo as R, Status as S, type UpdateParticipation as U, WebhookIdentityType as W, type ParticipationsQueryBuilder as a, type ParticipationCreatedEnvelope as b, type ParticipationDeletedEnvelope as c, type ParticipationUpdatedEnvelope as d, type ParticipationParticipatedItemOneOf as e, type Participant as f, type GetParticipationResponse as g, type CursorQuery as h, type CursorQueryPagingMethodOneOf as i, type CursorPaging as j, type QueryParticipationsResponse as k, type CursorPagingMetadata as l, type Cursors as m, type CreateParticipationRequest as n, type CreateParticipationResponse as o, type UpdateParticipationRequest as p, type UpdateParticipationResponse as q, type DeleteParticipationResponse as r, type DomainEvent as s, type DomainEventBodyOneOf as t, type EntityCreatedEvent as u, type EntityUpdatedEvent as v, type EntityDeletedEvent as w, type Empty as x, type SumParticipationsPartySizeByScheduleIdRequest as y, type SumParticipationsPartySizeByScheduleIdResponse as z };