@wix/auto_sdk_forms_form-submissions 1.0.0 → 1.0.1

package/build/cjs/src/service-plugins-types.d.ts

@@ -15,13 +15,20 @@ export interface ValidateSubmissionRequestActionsOneOf {
 export interface FormSubmission {
     /**
      * Submission ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** ID of the form which the submission belongs to. */
+    /**
+     * ID of the form which the submission belongs to.
+     * @format GUID
+     * @immutable
+     */
     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.
+     * @minLength 10
+     * @maxLength 50
      * @readonly
      */
     namespace?: string;
@@ -29,7 +36,10 @@ export interface FormSubmission {
     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. */
+    /**
+     * Date and time the form submission was created.
+     * @immutable
+     */
     _createdDate?: Date | null;
     /**
      * Date and time the form submission was updated.
@@ -52,14 +62,22 @@ export interface FormSubmission {
     extendedFields?: ExtendedFields;
     /**
      * Order details. <br>
-     * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
+     * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
      */
     orderDetails?: OrderDetails;
-    /** Contact ID of a site visitor who created the submission. */
+    /**
+     * Contact ID of a site visitor who created the submission.
+     * @format GUID
+     * @immutable
+     */
     contactId?: string | null;
-    /** authorized viewer user id */
+    /**
+     * Authorized viewer ID.
+     * @format GUID
+     * @immutable
+     */
     accessRestriction?: string | null;
-    /** Tag ids collections associated with current entity. */
+    /** Tag IDs collections associated with the current entity. */
     tags?: PublicTags;
 }
 export declare enum SubmissionStatus {
@@ -74,24 +92,48 @@ export declare enum SubmissionStatus {
     PAYMENT_CANCELED = "PAYMENT_CANCELED"
 }
 export interface Submitter extends SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 /** @oneof */
 export interface SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface ExtendedFields {
@@ -108,6 +150,7 @@ export interface ExtendedFields {
 export interface OrderDetails {
     /**
      * ID of the order related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     orderId?: string | null;
@@ -118,16 +161,19 @@ export interface OrderDetails {
     number?: string | null;
     /**
      * Currency.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
      * Item subtotal.
+     * @decimalValue options { gte:0.00, maxScale:2 }
      * @readonly
      */
     itemSubtotal?: string;
     /**
      * ID of the checkout related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     checkoutId?: string;
@@ -137,7 +183,11 @@ export interface PublicTags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export declare enum ActionType {
@@ -156,15 +206,22 @@ export interface ValidateSubmissionResponse {
     /**
      * List of validation errors. <br>
      * If there are no validation errors, returns an empty array.
+     * @maxSize 100
      */
     errors?: SubmissionValidationError[];
 }
 export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
-    /** Path indicating the source of the error, such as `form.fields.target`. */
+    /**
+     * Path indicating the source of the error, such as `form.fields.target`.
+     * @maxLength 500
+     */
     errorPath?: string;
     /** Additional error parameters. */
     params?: Record<string, any> | null;
@@ -173,7 +230,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
 export interface SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
 }
 export declare enum SubmissionErrorType {
@@ -215,13 +275,18 @@ export interface FormSubmissionSpiExtensionConfig {
      * the `deploymentUri` you provide here is `https://my-form-submissions.com/`.
      */
     deploymentUri?: SpiBaseUri;
-    /** Namespace names. */
+    /**
+     * Namespace names.
+     * @maxSize 10
+     */
     namespaceConfigs?: FormsSubmissionsExtensionNamespaceConfig[];
 }
 export 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/`.
+     * @minLength 6
+     * @maxLength 2048
      */
     baseUri?: string;
     /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
@@ -233,11 +298,15 @@ export interface AlternativeUri {
      *
      * For `methodName`, use the name of the method in PascalCase.
      * For example, for Get Shipping Rates use `GetShippingRates`.
+     * @minLength 3
+     * @maxLength 128
      */
     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`.
+     * @minLength 6
+     * @maxLength 2048
      */
     absoluteUri?: string;
 }
@@ -246,11 +315,14 @@ export 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.
+     * @minLength 10
+     * @maxLength 50
      */
     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.
+     * @format GUID
      */
     formId?: string | null;
     /** Enable submission validation. */
@@ -272,13 +344,19 @@ export interface FormsSubmissionsExtensionNamespaceConfig {
 export 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. */
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
     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. */
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
 }
 export declare enum IdentityType {
@@ -289,25 +367,49 @@ export declare enum IdentityType {
     APP = "APP"
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: IdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }

package/build/cjs/src/service-plugins-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAoEA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AA2ED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAmCD,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,mCAAnB,mBAAmB,QA+B9B;AAgFD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAsFA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AA2GD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA6CD,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,mCAAnB,mBAAmB,QA+B9B;AAkGD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}

package/build/es/src/service-plugins-types.d.ts

@@ -15,13 +15,20 @@ export interface ValidateSubmissionRequestActionsOneOf {
 export interface FormSubmission {
     /**
      * Submission ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** ID of the form which the submission belongs to. */
+    /**
+     * ID of the form which the submission belongs to.
+     * @format GUID
+     * @immutable
+     */
     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.
+     * @minLength 10
+     * @maxLength 50
      * @readonly
      */
     namespace?: string;
@@ -29,7 +36,10 @@ export interface FormSubmission {
     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. */
+    /**
+     * Date and time the form submission was created.
+     * @immutable
+     */
     _createdDate?: Date | null;
     /**
      * Date and time the form submission was updated.
@@ -52,14 +62,22 @@ export interface FormSubmission {
     extendedFields?: ExtendedFields;
     /**
      * Order details. <br>
-     * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
+     * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
      */
     orderDetails?: OrderDetails;
-    /** Contact ID of a site visitor who created the submission. */
+    /**
+     * Contact ID of a site visitor who created the submission.
+     * @format GUID
+     * @immutable
+     */
     contactId?: string | null;
-    /** authorized viewer user id */
+    /**
+     * Authorized viewer ID.
+     * @format GUID
+     * @immutable
+     */
     accessRestriction?: string | null;
-    /** Tag ids collections associated with current entity. */
+    /** Tag IDs collections associated with the current entity. */
     tags?: PublicTags;
 }
 export declare enum SubmissionStatus {
@@ -74,24 +92,48 @@ export declare enum SubmissionStatus {
     PAYMENT_CANCELED = "PAYMENT_CANCELED"
 }
 export interface Submitter extends SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 /** @oneof */
 export interface SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface ExtendedFields {
@@ -108,6 +150,7 @@ export interface ExtendedFields {
 export interface OrderDetails {
     /**
      * ID of the order related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     orderId?: string | null;
@@ -118,16 +161,19 @@ export interface OrderDetails {
     number?: string | null;
     /**
      * Currency.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
      * Item subtotal.
+     * @decimalValue options { gte:0.00, maxScale:2 }
      * @readonly
      */
     itemSubtotal?: string;
     /**
      * ID of the checkout related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     checkoutId?: string;
@@ -137,7 +183,11 @@ export interface PublicTags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export declare enum ActionType {
@@ -156,15 +206,22 @@ export interface ValidateSubmissionResponse {
     /**
      * List of validation errors. <br>
      * If there are no validation errors, returns an empty array.
+     * @maxSize 100
      */
     errors?: SubmissionValidationError[];
 }
 export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
-    /** Path indicating the source of the error, such as `form.fields.target`. */
+    /**
+     * Path indicating the source of the error, such as `form.fields.target`.
+     * @maxLength 500
+     */
     errorPath?: string;
     /** Additional error parameters. */
     params?: Record<string, any> | null;
@@ -173,7 +230,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
 export interface SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
 }
 export declare enum SubmissionErrorType {
@@ -215,13 +275,18 @@ export interface FormSubmissionSpiExtensionConfig {
      * the `deploymentUri` you provide here is `https://my-form-submissions.com/`.
      */
     deploymentUri?: SpiBaseUri;
-    /** Namespace names. */
+    /**
+     * Namespace names.
+     * @maxSize 10
+     */
     namespaceConfigs?: FormsSubmissionsExtensionNamespaceConfig[];
 }
 export 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/`.
+     * @minLength 6
+     * @maxLength 2048
      */
     baseUri?: string;
     /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
@@ -233,11 +298,15 @@ export interface AlternativeUri {
      *
      * For `methodName`, use the name of the method in PascalCase.
      * For example, for Get Shipping Rates use `GetShippingRates`.
+     * @minLength 3
+     * @maxLength 128
      */
     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`.
+     * @minLength 6
+     * @maxLength 2048
      */
     absoluteUri?: string;
 }
@@ -246,11 +315,14 @@ export 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.
+     * @minLength 10
+     * @maxLength 50
      */
     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.
+     * @format GUID
      */
     formId?: string | null;
     /** Enable submission validation. */
@@ -272,13 +344,19 @@ export interface FormsSubmissionsExtensionNamespaceConfig {
 export 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. */
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
     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. */
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
 }
 export declare enum IdentityType {
@@ -289,25 +367,49 @@ export declare enum IdentityType {
     APP = "APP"
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: IdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }

package/build/es/src/service-plugins-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":"AAoEA,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AA2ED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAmCD,MAAM,CAAN,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,KAAnB,mBAAmB,QA+B9B;AAgFD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":"AAsFA,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AA2GD,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AA6CD,MAAM,CAAN,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,KAAnB,mBAAmB,QA+B9B;AAkGD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}

package/build/internal/cjs/src/service-plugins-types.d.ts

@@ -15,13 +15,20 @@ export interface ValidateSubmissionRequestActionsOneOf {
 export interface FormSubmission {
     /**
      * Submission ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** ID of the form which the submission belongs to. */
+    /**
+     * ID of the form which the submission belongs to.
+     * @format GUID
+     * @immutable
+     */
     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.
+     * @minLength 10
+     * @maxLength 50
      * @readonly
      */
     namespace?: string;
@@ -29,7 +36,10 @@ export interface FormSubmission {
     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. */
+    /**
+     * Date and time the form submission was created.
+     * @immutable
+     */
     _createdDate?: Date | null;
     /**
      * Date and time the form submission was updated.
@@ -52,14 +62,22 @@ export interface FormSubmission {
     extendedFields?: ExtendedFields;
     /**
      * Order details. <br>
-     * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
+     * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
      */
     orderDetails?: OrderDetails;
-    /** Contact ID of a site visitor who created the submission. */
+    /**
+     * Contact ID of a site visitor who created the submission.
+     * @format GUID
+     * @immutable
+     */
     contactId?: string | null;
-    /** authorized viewer user id */
+    /**
+     * Authorized viewer ID.
+     * @format GUID
+     * @immutable
+     */
     accessRestriction?: string | null;
-    /** Tag ids collections associated with current entity. */
+    /** Tag IDs collections associated with the current entity. */
     tags?: PublicTags;
 }
 export declare enum SubmissionStatus {
@@ -74,24 +92,48 @@ export declare enum SubmissionStatus {
     PAYMENT_CANCELED = "PAYMENT_CANCELED"
 }
 export interface Submitter extends SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 /** @oneof */
 export interface SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface ExtendedFields {
@@ -108,6 +150,7 @@ export interface ExtendedFields {
 export interface OrderDetails {
     /**
      * ID of the order related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     orderId?: string | null;
@@ -118,16 +161,19 @@ export interface OrderDetails {
     number?: string | null;
     /**
      * Currency.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
      * Item subtotal.
+     * @decimalValue options { gte:0.00, maxScale:2 }
      * @readonly
      */
     itemSubtotal?: string;
     /**
      * ID of the checkout related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     checkoutId?: string;
@@ -137,7 +183,11 @@ export interface PublicTags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export declare enum ActionType {
@@ -156,15 +206,22 @@ export interface ValidateSubmissionResponse {
     /**
      * List of validation errors. <br>
      * If there are no validation errors, returns an empty array.
+     * @maxSize 100
      */
     errors?: SubmissionValidationError[];
 }
 export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
-    /** Path indicating the source of the error, such as `form.fields.target`. */
+    /**
+     * Path indicating the source of the error, such as `form.fields.target`.
+     * @maxLength 500
+     */
     errorPath?: string;
     /** Additional error parameters. */
     params?: Record<string, any> | null;
@@ -173,7 +230,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
 export interface SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
 }
 export declare enum SubmissionErrorType {
@@ -215,13 +275,18 @@ export interface FormSubmissionSpiExtensionConfig {
      * the `deploymentUri` you provide here is `https://my-form-submissions.com/`.
      */
     deploymentUri?: SpiBaseUri;
-    /** Namespace names. */
+    /**
+     * Namespace names.
+     * @maxSize 10
+     */
     namespaceConfigs?: FormsSubmissionsExtensionNamespaceConfig[];
 }
 export 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/`.
+     * @minLength 6
+     * @maxLength 2048
      */
     baseUri?: string;
     /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
@@ -233,11 +298,15 @@ export interface AlternativeUri {
      *
      * For `methodName`, use the name of the method in PascalCase.
      * For example, for Get Shipping Rates use `GetShippingRates`.
+     * @minLength 3
+     * @maxLength 128
      */
     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`.
+     * @minLength 6
+     * @maxLength 2048
      */
     absoluteUri?: string;
 }
@@ -246,11 +315,14 @@ export 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.
+     * @minLength 10
+     * @maxLength 50
      */
     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.
+     * @format GUID
      */
     formId?: string | null;
     /** Enable submission validation. */
@@ -272,13 +344,19 @@ export interface FormsSubmissionsExtensionNamespaceConfig {
 export 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. */
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
     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. */
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
 }
 export declare enum IdentityType {
@@ -289,25 +367,49 @@ export declare enum IdentityType {
     APP = "APP"
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: IdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }

package/build/internal/cjs/src/service-plugins-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAoEA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AA2ED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAmCD,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,mCAAnB,mBAAmB,QA+B9B;AAgFD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAsFA,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AA2GD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA6CD,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,mCAAnB,mBAAmB,QA+B9B;AAkGD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}

package/build/internal/es/src/service-plugins-types.d.ts

@@ -15,13 +15,20 @@ export interface ValidateSubmissionRequestActionsOneOf {
 export interface FormSubmission {
     /**
      * Submission ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** ID of the form which the submission belongs to. */
+    /**
+     * ID of the form which the submission belongs to.
+     * @format GUID
+     * @immutable
+     */
     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.
+     * @minLength 10
+     * @maxLength 50
      * @readonly
      */
     namespace?: string;
@@ -29,7 +36,10 @@ export interface FormSubmission {
     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. */
+    /**
+     * Date and time the form submission was created.
+     * @immutable
+     */
     _createdDate?: Date | null;
     /**
      * Date and time the form submission was updated.
@@ -52,14 +62,22 @@ export interface FormSubmission {
     extendedFields?: ExtendedFields;
     /**
      * Order details. <br>
-     * <b>Note</b>: This object is only applicable when submittng a form in the Wix Payments app.
+     * <b>Note</b>: This object is only applicable when submitting a form in the Wix Payments app.
      */
     orderDetails?: OrderDetails;
-    /** Contact ID of a site visitor who created the submission. */
+    /**
+     * Contact ID of a site visitor who created the submission.
+     * @format GUID
+     * @immutable
+     */
     contactId?: string | null;
-    /** authorized viewer user id */
+    /**
+     * Authorized viewer ID.
+     * @format GUID
+     * @immutable
+     */
     accessRestriction?: string | null;
-    /** Tag ids collections associated with current entity. */
+    /** Tag IDs collections associated with the current entity. */
     tags?: PublicTags;
 }
 export declare enum SubmissionStatus {
@@ -74,24 +92,48 @@ export declare enum SubmissionStatus {
     PAYMENT_CANCELED = "PAYMENT_CANCELED"
 }
 export interface Submitter extends SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 /** @oneof */
 export interface SubmitterSubmitterOneOf {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string | null;
-    /** Visitor ID. */
+    /**
+     * Visitor ID.
+     * @format GUID
+     */
     visitorId?: string | null;
-    /** Application ID. */
+    /**
+     * Application ID.
+     * @maxLength 36
+     */
     applicationId?: string | null;
-    /** User ID. */
+    /**
+     * User ID.
+     * @format GUID
+     */
     userId?: string | null;
 }
 export interface ExtendedFields {
@@ -108,6 +150,7 @@ export interface ExtendedFields {
 export interface OrderDetails {
     /**
      * ID of the order related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     orderId?: string | null;
@@ -118,16 +161,19 @@ export interface OrderDetails {
     number?: string | null;
     /**
      * Currency.
+     * @format CURRENCY
      * @readonly
      */
     currency?: string | null;
     /**
      * Item subtotal.
+     * @decimalValue options { gte:0.00, maxScale:2 }
      * @readonly
      */
     itemSubtotal?: string;
     /**
      * ID of the checkout related to submission (only applicable if a form has payments).
+     * @format GUID
      * @readonly
      */
     checkoutId?: string;
@@ -137,7 +183,11 @@ export interface PublicTags {
     tags?: TagList;
 }
 export interface TagList {
-    /** List of tag IDs */
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
     tagIds?: string[];
 }
 export declare enum ActionType {
@@ -156,15 +206,22 @@ export interface ValidateSubmissionResponse {
     /**
      * List of validation errors. <br>
      * If there are no validation errors, returns an empty array.
+     * @maxSize 100
      */
     errors?: SubmissionValidationError[];
 }
 export interface SubmissionValidationError extends SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
-    /** Path indicating the source of the error, such as `form.fields.target`. */
+    /**
+     * Path indicating the source of the error, such as `form.fields.target`.
+     * @maxLength 500
+     */
     errorPath?: string;
     /** Additional error parameters. */
     params?: Record<string, any> | null;
@@ -173,7 +230,10 @@ export interface SubmissionValidationError extends SubmissionValidationErrorErro
 export interface SubmissionValidationErrorErrorMessageOneOf {
     /** Predefined error type. */
     errorType?: SubmissionErrorType;
-    /** Custom error message. The message is displayed instead of an error type. */
+    /**
+     * Custom error message. The message is displayed instead of an error type.
+     * @maxLength 500
+     */
     customErrorMessage?: string;
 }
 export declare enum SubmissionErrorType {
@@ -215,13 +275,18 @@ export interface FormSubmissionSpiExtensionConfig {
      * the `deploymentUri` you provide here is `https://my-form-submissions.com/`.
      */
     deploymentUri?: SpiBaseUri;
-    /** Namespace names. */
+    /**
+     * Namespace names.
+     * @maxSize 10
+     */
     namespaceConfigs?: FormsSubmissionsExtensionNamespaceConfig[];
 }
 export 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/`.
+     * @minLength 6
+     * @maxLength 2048
      */
     baseUri?: string;
     /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
@@ -233,11 +298,15 @@ export interface AlternativeUri {
      *
      * For `methodName`, use the name of the method in PascalCase.
      * For example, for Get Shipping Rates use `GetShippingRates`.
+     * @minLength 3
+     * @maxLength 128
      */
     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`.
+     * @minLength 6
+     * @maxLength 2048
      */
     absoluteUri?: string;
 }
@@ -246,11 +315,14 @@ export 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.
+     * @minLength 10
+     * @maxLength 50
      */
     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.
+     * @format GUID
      */
     formId?: string | null;
     /** Enable submission validation. */
@@ -272,13 +344,19 @@ export interface FormsSubmissionsExtensionNamespaceConfig {
 export 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. */
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
     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. */
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
 }
 export declare enum IdentityType {
@@ -289,25 +367,49 @@ export declare enum IdentityType {
     APP = "APP"
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: IdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }

package/build/internal/es/src/service-plugins-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":"AAoEA,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AA2ED,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AAmCD,MAAM,CAAN,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,KAAnB,mBAAmB,QA+B9B;AAgFD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":"AAsFA,MAAM,CAAN,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2EAAuD,CAAA;IACvD,0FAA0F;IAC1F,uCAAmB,CAAA;IACnB,4DAA4D;IAC5D,2CAAuB,CAAA;IACvB,sDAAsD;IACtD,uDAAmC,CAAA;IACnC,iDAAiD;IACjD,yDAAqC,CAAA;AACvC,CAAC,EAVW,gBAAgB,KAAhB,gBAAgB,QAU3B;AA2GD,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,2BAA2B;IAC3B,+CAAiC,CAAA;IACjC,yBAAyB;IACzB,+BAAiB,CAAA;IACjB,yBAAyB;IACzB,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AA6CD,MAAM,CAAN,IAAY,mBA+BX;AA/BD,WAAY,mBAAmB;IAC7B,mEAAmE;IACnE,sDAA+B,CAAA;IAC/B,4CAA4C;IAC5C,gDAAyB,CAAA;IACzB,wCAAwC;IACxC,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,qCAAqC;IACrC,4DAAqC,CAAA;IACrC,4CAA4C;IAC5C,4DAAqC,CAAA;IACrC,yDAAyD;IACzD,sDAA+B,CAAA;IAC/B,wDAAwD;IACxD,oDAA6B,CAAA;IAC7B,+BAA+B;IAC/B,0DAAmC,CAAA;IACnC,iCAAiC;IACjC,0DAAmC,CAAA;IACnC,yDAAyD;IACzD,0EAAmD,CAAA;IACnD,sCAAsC;IACtC,0DAAmC,CAAA;IACnC,wCAAwC;IACxC,0DAAmC,CAAA;IACnC,kDAAkD;IAClD,0EAAmD,CAAA;IACnD,kCAAkC;IAClC,kEAA2C,CAAA;AAC7C,CAAC,EA/BW,mBAAmB,KAAnB,mBAAmB,QA+B9B;AAkGD,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_forms_form-submissions",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -48,5 +48,5 @@
       "fqdn": "wix.interfaces.forms.v4.submission_extension"
     }
   },
-  "falconPackageHash": "e570c56a87efe44aefcf2b5347c5afc0808a6ec403073d14dc651f91"
+  "falconPackageHash": "26f4f6f529aeeb64bf2888998ff10937a4f7eb276ba8a753bdca1fa8"
 }