@wix/auto_sdk_events_forms 1.0.37 → 1.0.39

package/build/internal/es/index.typings.d.mts

@@ -293,13 +293,14 @@ declare enum RequestedFields {
 type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DELETED';
 interface GetFormResponse {
     /**
-     * Currently published event form.
-     * Published form is visible to site visitors.
+     * Event form.
+     * Form is visible to site visitors.
      */
     form?: Form;
     /**
-     * Draft event form.
-     * Not available to visitors unless published.
+     * Deprecated, currently returns the same value as the form field.
+     * @deprecated Deprecated, currently returns the same value as the form field.
+     * @targetRemovalDate 2026-06-30
      */
     draftForm?: Form;
 }
@@ -500,7 +501,7 @@ interface TextControl {
 interface AddControlResponse {
     /** Generated unique input control ID. */
     _id?: string;
-    /** Modified draft event form. */
+    /** Modified event form. */
     form?: Form;
 }
 interface UpdateControlRequest extends UpdateControlRequestControlOneOf {
@@ -581,7 +582,7 @@ interface EmailControl {
     label?: string;
 }
 interface UpdateControlResponse {
-    /** Modified draft event form. */
+    /** Modified event form. */
     form?: Form;
 }
 interface DeleteControlRequest {
@@ -616,7 +617,7 @@ interface UpdateMessagesRequest {
     messages?: FormMessages;
 }
 interface UpdateMessagesResponse {
-    /** Modified draft event form. */
+    /** Modified event form. */
     form?: Form;
 }
 interface PublishDraftRequest {
@@ -627,7 +628,7 @@ interface PublishDraftRequest {
     eventId: string;
 }
 interface PublishDraftResponse {
-    /** Published event form. */
+    /** Event form. */
     form?: Form;
 }
 interface EventUpdated {
@@ -3344,8 +3345,6 @@ declare function onFormEventUpdated(handler: (event: FormEventUpdatedEnvelope) =
 type FormNonNullablePaths = `controls` | `controls.${number}.type` | `controls.${number}.system` | `controls.${number}.name` | `controls.${number}.label` | `controls.${number}.orderIndex` | `controls.${number}._id` | `messages.rsvp.rsvpYesOption` | `messages.rsvp.rsvpNoOption` | `messages.rsvp.positiveMessages.title` | `messages.rsvp.positiveMessages.confirmation.title` | `messages.rsvp.positiveMessages.confirmation.message` | `messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `messages.rsvp.negativeMessages.title` | `messages.rsvp.negativeMessages.confirmation.title` | `messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `messages.rsvp.submitActionLabel` | `messages.checkout.title` | `messages.checkout.submitActionLabel` | `messages.checkout.confirmation.title` | `messages.checkout.confirmation.message` | `messages.checkout.confirmation.downloadTicketsLabel` | `messages.checkout.confirmation.addToCalendarLabel` | `messages.checkout.confirmation.shareEventLabel` | `messages.registrationClosed.message` | `messages.registrationClosed.exploreEventsActionLabel` | `messages.ticketsUnavailable.message` | `messages.ticketsUnavailable.exploreEventsActionLabel`;
 /**
  * Retrieves an event registration form.
- *
- * Retrieves both the draft and published versions.
  * @param eventId - Event ID to which the form belongs.
  * @public
  * @requiredField eventId
@@ -3353,13 +3352,13 @@ type FormNonNullablePaths = `controls` | `controls.${number}.type` | `controls.$
  * @permissionId WIX_EVENTS.READ_EVENTS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns Currently published event form.
- * Published form is visible to site visitors.
+ * @returns Event form.
+ * Form is visible to site visitors.
  * @fqn wix.events.form.FormBuilder.GetForm
  */
 declare function getForm(eventId: string): Promise<NonNullablePaths<Form, FormNonNullablePaths>>;
 /**
- * Adds an input control to the draft form.
+ * Adds an input control to the form. The applied changes trigger form publishing.
  * @param eventId - Event ID to which the form belongs.
  * @public
  * @requiredField eventId
@@ -3413,7 +3412,7 @@ interface AddControlOptionsControlOneOf {
     radioButton?: RadioButtonControl;
 }
 /**
- * Updates an existing input control in the draft form.
+ * Updates an existing input control in the form. The applied changes trigger form publishing.
  * @public
  * @requiredField identifiers
  * @requiredField identifiers._id
@@ -3510,7 +3509,7 @@ interface UpdateControlOptionsControlOneOf {
     radioButton?: RadioButtonControl;
 }
 /**
- * Deletes an input control from the draft form.
+ * Deletes an input control from the form. The applied changes trigger form publishing.
  * @public
  * @requiredField identifiers
  * @requiredField identifiers._id
@@ -3569,6 +3568,8 @@ interface UpdateMessagesOptions {
  * @permissionId WIX_EVENTS.MANAGE_EVENTS
  * @applicableIdentity APP
  * @fqn wix.events.form.FormBuilder.PublishDraft
+ * @deprecated
+ * @targetRemovalDate 2026-01-05
  */
 declare function publishDraft(eventId: string): Promise<NonNullablePaths<PublishDraftResponse, {
     [P in FormNonNullablePaths]: `form.${P}`;
@@ -3581,6 +3582,8 @@ declare function publishDraft(eventId: string): Promise<NonNullablePaths<Publish
  * @permissionId WIX_EVENTS.MANAGE_EVENTS
  * @applicableIdentity APP
  * @fqn wix.events.form.FormBuilder.DiscardDraft
+ * @deprecated
+ * @targetRemovalDate 2026-01-05
  */
 declare function discardDraft(eventId: string): Promise<void>;