@wix/forms 1.0.185 → 1.0.187

package/type-bundles/service-plugins.bundle.d.ts

@@ -1,389 +0,0 @@
-interface ValidateSubmissionRequest extends ValidateSubmissionRequestActionsOneOf {
-    /** Data for updating an existing submission. */
-    updateOptions?: UpdateOptions;
-    /** Submission to validate. */
-    submission: FormSubmission;
-    /** Whether to create or update the submission. */
-    actionType: ActionType;
-}
-/** @oneof */
-interface ValidateSubmissionRequestActionsOneOf {
-    /** Data for updating an existing submission. */
-    updateOptions?: UpdateOptions;
-}
-/** Form submission that was created or retrieved. */
-interface FormSubmission {
-    /**
-     * Submission ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** ID of the form which the submission belongs to. */
-    formId?: string;
-    /**
-     * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `Get Submission` to retrieve the namespace.
-     * @readonly
-     */
-    namespace?: string;
-    /** Status of the submission. */
-    status?: SubmissionStatus;
-    /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
-    submissions?: Record<string, any>;
-    /** Date and time the form submission was created. */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the form submission was updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * ID of the visitor that submitted the form.
-     * @readonly
-     */
-    submitter?: Submitter;
-    /** Whether a site owner marked a submission as "seen". */
-    seen?: boolean;
-    /** Data extension object that holds users' and apps' fields. */
-    extendedFields?: ExtendedFields;
-    /**
-     * Order details. <br>
-     * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
-     */
-    orderDetails?: OrderDetails;
-    /** Contact ID of a site visitor who created the submission. */
-    contactId?: string | null;
-}
-declare enum SubmissionStatus {
-    UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
-    /** A submission is created, but has not yet been recorded in the Wix Forms collection. */
-    PENDING = "PENDING",
-    /** A submission is recorded in the Wix Forms collection. */
-    CONFIRMED = "CONFIRMED",
-    /** A form submission requiring payment is created. */
-    PAYMENT_WAITING = "PAYMENT_WAITING",
-    /** An order of a form submission is canceled. */
-    PAYMENT_CANCELED = "PAYMENT_CANCELED"
-}
-interface Submitter extends SubmitterSubmitterOneOf {
-    /** Member ID. */
-    memberId?: string | null;
-    /** Visitor ID. */
-    visitorId?: string | null;
-    /** Application ID. */
-    applicationId?: string | null;
-    /** User ID. */
-    userId?: string | null;
-}
-/** @oneof */
-interface SubmitterSubmitterOneOf {
-    /** Member ID. */
-    memberId?: string | null;
-    /** Visitor ID. */
-    visitorId?: string | null;
-    /** Application ID. */
-    applicationId?: string | null;
-    /** User ID. */
-    userId?: string | null;
-}
-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 OrderDetails {
-    /**
-     * ID of the order related to submission (only applicable if a form has payments).
-     * @readonly
-     */
-    orderId?: string | null;
-    /**
-     * Order number.
-     * @readonly
-     */
-    number?: string | null;
-    /**
-     * Currency.
-     * @readonly
-     */
-    currency?: string | null;
-    /**
-     * Item subtotal.
-     * @readonly
-     */
-    itemSubtotal?: string;
-    /**
-     * ID of the checkout related to submission (only applicable if a form has payments).
-     * @readonly
-     */
-    checkoutId?: string;
-}
-declare enum ActionType {
-    /** Unknown action type. */
-    UNKNOWN_ACTION = "UNKNOWN_ACTION",
-    /** Update submission. */
-    UPDATE = "UPDATE",
-    /** Create submission. */
-    CREATE = "CREATE"
-}
-interface UpdateOptions {
-    /** Submission to update. */
-    currentSubmission?: FormSubmission;
-}
-interface ValidateSubmissionResponse {
-    /**
-     * List of validation errors. <br>
-     * If there are no validation errors, returns an empty array.
-     */
-    errors?: SubmissionValidationError[];
-}
-interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
-    /** Predefined error type. */
-    errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
-    customErrorMessage?: string;
-    /** Path indicating the source of the error, such as `form.fields.target`. */
-    errorPath?: string;
-    /** Additional error parameters. */
-    params?: Record<string, any> | null;
-}
-/** @oneof */
-interface SubmissionValidationErrorErrorMessageOneOf {
-    /** Predefined error type. */
-    errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
-    customErrorMessage?: string;
-}
-declare enum SubmissionErrorType {
-    /** Error is unknown or unsuitable for any of the options below. */
-    UNKNOWN_ERROR = "UNKNOWN_ERROR",
-    /** Type of submitted value is incorrect. */
-    TYPE_ERROR = "TYPE_ERROR",
-    /** Value is required to be provided. */
-    REQUIRED_VALUE_ERROR = "REQUIRED_VALUE_ERROR",
-    /** Value contains additional properties not expected in schema. */
-    UNKNOWN_VALUE_ERROR = "UNKNOWN_VALUE_ERROR",
-    /** Text value exceeds max length. */
-    MAX_LENGTH_ERROR = "MAX_LENGTH_ERROR",
-    /** Text value does not reach min length. */
-    MIN_LENGTH_ERROR = "MIN_LENGTH_ERROR",
-    /** Text value is not applicable for expected pattern. */
-    PATTERN_ERROR = "PATTERN_ERROR",
-    /** Text value is not applicable for expected format. */
-    FORMAT_ERROR = "FORMAT_ERROR",
-    /** Number value is too big. */
-    MAX_VALUE_ERROR = "MAX_VALUE_ERROR",
-    /** Number value is too small. */
-    MIN_VALUE_ERROR = "MIN_VALUE_ERROR",
-    /** Number value is not a multiple of expected number. */
-    MULTIPLE_OF_VALUE_ERROR = "MULTIPLE_OF_VALUE_ERROR",
-    /** Array value has too many items. */
-    MIN_ITEMS_ERROR = "MIN_ITEMS_ERROR",
-    /** Array value has not enough items. */
-    MAX_ITEMS_ERROR = "MAX_ITEMS_ERROR",
-    /** Value is not in the list of allowed values. */
-    NOT_ALLOWED_VALUE_ERROR = "NOT_ALLOWED_VALUE_ERROR",
-    /** Submitted form is disabled. */
-    DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
-}
-interface FormSubmissionSpiExtensionConfig {
-    /**
-     * Deployment URI where the endpoints are called. Wix Forms appends the endpoint path to the deployment URI.
-     * For example, to call the Validate Submission endpoint at `https://my-form-submissions.com/v1/validateSubmission`,
-     * the `deploymentUri` you provide here is `https://my-form-submissions.com/`.
-     */
-    deploymentUri?: SpiBaseUri;
-    /** Namespace names. */
-    namespaceConfigs?: FormsSubmissionsExtensionNamespaceConfig[];
-}
-interface SpiBaseUri {
-    /**
-     * Base URI where the methods are called. Wix appends the path to the `baseUri`.
-     * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
-     */
-    baseUri?: string;
-    /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
-    alternativeUris?: AlternativeUri[];
-}
-interface AlternativeUri {
-    /**
-     * Name of the method to create a custom URI for.
-     *
-     * For `methodName`, use the name of the method in PascalCase.
-     * For example, for Get Shipping Rates use `GetShippingRates`.
-     */
-    methodName?: string;
-    /**
-     * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
-     * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
-     */
-    absoluteUri?: string;
-}
-interface FormsSubmissionsExtensionNamespaceConfig {
-    /**
-     * The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`.
-     *
-     * Call `Get Submission` to retrieve the namespace.
-     */
-    namespace?: string;
-    /**
-     * The ID of the specific form that will trigger the defined methods when a submission is made.
-     * This field is optional. If not provided, submissions from all forms will trigger the methods.
-     */
-    formId?: string | null;
-    /** Enable submission validation. */
-    submissionValidationEnabled?: boolean;
-}
-/**
- * this message is not directly used by any service,
- * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
- * e.g. SPIs, event-handlers, etc..
- * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
- *
- * Example:
- * ```typescript
- * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
- * ...
- * }
- * ```
- */
-interface Context {
-    /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
-    requestId?: string | null;
-    /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
-    currency?: string | null;
-    /** An object that describes the identity that triggered this request. */
-    identity?: IdentificationData;
-    /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
-    languages?: string[];
-    /** The service provider app's instance ID. */
-    instanceId?: string | null;
-}
-declare enum IdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** @readonly */
-    identityType?: IdentityType;
-}
-/** @oneof */
-interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-}
-
-type ServicePluginMethodInput = {
-    request: any;
-    metadata: any;
-};
-type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata = {
-    name: string;
-    primaryHttpMappingPath: string;
-    transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
-        toREST: (...args: unknown[]) => unknown;
-    };
-};
-type ServicePluginDefinition<Contract extends ServicePluginContract> = {
-    __type: 'service-plugin-definition';
-    componentType: string;
-    methods: ServicePluginMethodMetadata[];
-    __contract: Contract;
-};
-declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
-type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-declare global {
-    interface ContextualClient {
-    }
-}
-
-interface ValidateSubmissionEnvelope {
-    request: ValidateSubmissionRequest;
-    metadata: Context;
-}
-declare const provideHandlers$1: ServicePluginDefinition<{
-    /**
-     *
-     * > **Note:** The Form Submission service plugin only works with the Wix Forms app.
-     *
-     * Validates a submission.
-     *
-     * Validates a site visitor's form submission and returns any validation violations. Site visitors can see the validation violations on their forms. For example, invalid fields are highlighted in red. */
-    validateSubmission(payload: ValidateSubmissionEnvelope): ValidateSubmissionResponse | Promise<ValidateSubmissionResponse>;
-}>;
-
-declare function createServicePluginModule<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
-
-type _publicProvideHandlersType = typeof provideHandlers$1;
-declare const provideHandlers: ReturnType<typeof createServicePluginModule<_publicProvideHandlersType>>;
-
-type index_d_ActionType = ActionType;
-declare const index_d_ActionType: typeof ActionType;
-type index_d_AlternativeUri = AlternativeUri;
-type index_d_Context = Context;
-type index_d_ExtendedFields = ExtendedFields;
-type index_d_FormSubmission = FormSubmission;
-type index_d_FormSubmissionSpiExtensionConfig = FormSubmissionSpiExtensionConfig;
-type index_d_FormsSubmissionsExtensionNamespaceConfig = FormsSubmissionsExtensionNamespaceConfig;
-type index_d_IdentificationData = IdentificationData;
-type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
-type index_d_IdentityType = IdentityType;
-declare const index_d_IdentityType: typeof IdentityType;
-type index_d_OrderDetails = OrderDetails;
-type index_d_SpiBaseUri = SpiBaseUri;
-type index_d_SubmissionErrorType = SubmissionErrorType;
-declare const index_d_SubmissionErrorType: typeof SubmissionErrorType;
-type index_d_SubmissionStatus = SubmissionStatus;
-declare const index_d_SubmissionStatus: typeof SubmissionStatus;
-type index_d_SubmissionValidationError = SubmissionValidationError;
-type index_d_SubmissionValidationErrorErrorMessageOneOf = SubmissionValidationErrorErrorMessageOneOf;
-type index_d_Submitter = Submitter;
-type index_d_SubmitterSubmitterOneOf = SubmitterSubmitterOneOf;
-type index_d_UpdateOptions = UpdateOptions;
-type index_d_ValidateSubmissionRequest = ValidateSubmissionRequest;
-type index_d_ValidateSubmissionRequestActionsOneOf = ValidateSubmissionRequestActionsOneOf;
-type index_d_ValidateSubmissionResponse = ValidateSubmissionResponse;
-type index_d__publicProvideHandlersType = _publicProvideHandlersType;
-declare const index_d_provideHandlers: typeof provideHandlers;
-declare namespace index_d {
-  export { index_d_ActionType as ActionType, type index_d_AlternativeUri as AlternativeUri, type index_d_Context as Context, type index_d_ExtendedFields as ExtendedFields, type index_d_FormSubmission as FormSubmission, type index_d_FormSubmissionSpiExtensionConfig as FormSubmissionSpiExtensionConfig, type index_d_FormsSubmissionsExtensionNamespaceConfig as FormsSubmissionsExtensionNamespaceConfig, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_OrderDetails as OrderDetails, type index_d_SpiBaseUri as SpiBaseUri, index_d_SubmissionErrorType as SubmissionErrorType, index_d_SubmissionStatus as SubmissionStatus, type index_d_SubmissionValidationError as SubmissionValidationError, type index_d_SubmissionValidationErrorErrorMessageOneOf as SubmissionValidationErrorErrorMessageOneOf, type index_d_Submitter as Submitter, type index_d_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, type index_d_UpdateOptions as UpdateOptions, type index_d_ValidateSubmissionRequest as ValidateSubmissionRequest, type index_d_ValidateSubmissionRequestActionsOneOf as ValidateSubmissionRequestActionsOneOf, type index_d_ValidateSubmissionResponse as ValidateSubmissionResponse, type index_d__publicProvideHandlersType as _publicProvideHandlersType, index_d_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
-}
-
-export { index_d as formSubmissions };