@wix/forms 1.0.63 → 1.0.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/forms-v4-submission.public.d.ts +2 -11
- package/build/cjs/src/forms-v4-submission.types.d.ts +22 -17
- package/build/cjs/src/forms-v4-submission.types.js.map +1 -1
- package/build/cjs/src/forms-v4-submission.universal.d.ts +37 -30
- package/build/cjs/src/forms-v4-submission.universal.js +107 -60
- package/build/cjs/src/forms-v4-submission.universal.js.map +1 -1
- package/build/es/src/forms-v4-submission.public.d.ts +2 -11
- package/build/es/src/forms-v4-submission.types.d.ts +22 -17
- package/build/es/src/forms-v4-submission.types.js.map +1 -1
- package/build/es/src/forms-v4-submission.universal.d.ts +37 -30
- package/build/es/src/forms-v4-submission.universal.js +107 -60
- package/build/es/src/forms-v4-submission.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -4,16 +4,7 @@ export declare const __metadata: {
|
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
6
6
|
export declare function createSubmission(httpClient: HttpClient): (submission: FormSubmission, options?: CreateSubmissionOptions) => Promise<import("./forms-v4-submission.universal").CreateSubmissionResponse & import("./forms-v4-submission.universal").CreateSubmissionResponseNonNullableFields>;
|
|
7
|
-
export declare function getSubmission(httpClient: HttpClient): (submissionId: string) => Promise<
|
|
8
|
-
formId: string;
|
|
9
|
-
namespace: string;
|
|
10
|
-
status: import("./forms-v4-submission.universal").SubmissionStatus;
|
|
11
|
-
seen: boolean;
|
|
12
|
-
orderDetails?: {
|
|
13
|
-
itemSubtotal: string;
|
|
14
|
-
checkoutId: string;
|
|
15
|
-
} | undefined;
|
|
16
|
-
}>;
|
|
7
|
+
export declare function getSubmission(httpClient: HttpClient): (submissionId: string) => Promise<import("./forms-v4-submission.universal").GetSubmissionResponse & import("./forms-v4-submission.universal").GetSubmissionResponseNonNullableFields>;
|
|
17
8
|
export declare function updateSubmission(httpClient: HttpClient): (_id: string | null, submission: UpdateSubmission) => Promise<FormSubmission & {
|
|
18
9
|
formId: string;
|
|
19
10
|
namespace: string;
|
|
@@ -38,4 +29,4 @@ export declare function countDeletedSubmissions(httpClient: HttpClient): (formId
|
|
|
38
29
|
export declare function getMediaUploadUrl(httpClient: HttpClient): (formId: string, filename: string, mimeType: string) => Promise<import("./forms-v4-submission.universal").GetMediaUploadURLResponse & import("./forms-v4-submission.universal").GetMediaUploadURLResponseNonNullableFields>;
|
|
39
30
|
export declare function bulkMarkSubmissionsAsSeen(httpClient: HttpClient): (ids: string[], formId: string) => Promise<void>;
|
|
40
31
|
export { SubmissionStatus, Format, ValidationFormat, ProductType, PriceType, FormatEnumFormat, StringComponentType, NodeType, WidthType, PluginContainerDataAlignment, Type, LinkTarget, TextAlignment, LineStyle, Width, Alignment, ViewMode, LayoutType, Orientation, Crop, ThumbnailsAlignment, Source, MapType, ViewRole, VoteRole, PollLayoutType, PollLayoutDirection, BackgroundType, DecorationType, FontType, AppType, InitialExpandedItems, Direction, VerticalAlignment, NullValue, DateFormatPart, DateTimeInputType, NumberComponentType, BooleanComponentType, ItemType, PropertiesTypePropertiesType, ComponentType, WixFileComponentType, UploadFileFormat, PaymentComponentType, InputType, Target, FieldType, OverrideEntityType, Kind, EmailInfoTag, PhoneInfoTag, Tag, ContactField, IdentityType, SortOrder, } from './forms-v4-submission.universal';
|
|
41
|
-
export { FormSubmission, Owner, OwnerOwnerOneOf, Submitter, SubmitterSubmitterOneOf, ExtendedFields, OrderDetails, CreateCheckoutFromSubmissionRequest, CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf, Form, FormField, StringType, StringTypeFormatOptionsOneOf, StringErrorMessages, DateTimeConstraints, NumberType, NumberErrorMessages, IntegerType, BooleanType, BooleanErrorMessages, ArrayType, ObjectType, PropertiesType, PropertiesTypePropertiesTypeOneOf, ObjectErrorMessages, ArrayItems, ArrayItemsItemsOneOf, ArrayErrorMessages, PredefinedValidation, PredefinedValidationFormatOptionsOneOf, PaymentType, QuantityLimit, FixedPriceOptions, DynamicPriceOptions, Product, ProductPriceOptionsOneOf, NestedFormFieldOverrides, Validation, ValidationValidationOneOf, DataExtensionsDetails, NestedFormOverrides, FormFieldV2, FormFieldV2FieldTypeOptionsOneOf, InputFieldStringType, InputFieldStringErrorMessages, TextInput, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, LinkPreviewData, MapData, MapSettings, ParagraphData, PollData, Permissions, PollOption, Settings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, Metadata, DocumentStyle, TextNodeStyle, RadioGroup, RadioGroupOption, RadioGroupCustomOption, Dropdown, DropdownOption, DropdownCustomOption, DateTimeInput, DateTimeInputDateTimeInputTypeOptionsOneOf, DateTimeOptions, DateOptions, TimeOptions, InputFieldNumberType, InputFieldNumberErrorMessages, NumberInput, InputFieldBooleanType, InputFieldBooleanErrorMessages, Checkbox, InputFieldArrayType, InputFieldIntegerType, InputFieldObjectType, ObjectTypePropertiesType, ObjectTypePropertiesTypePropertiesTypeOptionsOneOf, InputFieldObjectErrorMessages, ArrayTypeArrayItems, ArrayTypeArrayItemsItemTypeOptionsOneOf, InputFieldArrayErrorMessages, CheckboxGroup, MediaItem, MediaItemMediaOneOf, Option, CustomOption, FileUpload, ProductCheckboxGroup, ProductCheckboxGroupOption, _String, _StringComponentTypeOptionsOneOf, _Number, _NumberComponentTypeOptionsOneOf, _Boolean, _BooleanComponentTypeOptionsOneOf, _Array, _ArrayComponentTypeOptionsOneOf, _Object, _ObjectValidationOneOf, WixFile, WixFileComponentTypeOptionsOneOf, Payment, PaymentComponentTypeOptionsOneOf, Header, RichText, ThankYouMessage, Redirect, InputField, InputFieldInputTypeOptionsOneOf, DisplayField, DisplayFieldComponentTypeOneOf, SubmitButton, SubmitButtonSubmitActionOneOf, Step, FormLayout, BreakPoint, ItemLayout, Margin, Section, FormRule, FormOverride, FormProperties, PostSubmissionTriggers, UpsertContact, FormFieldContactInfo, FormFieldContactInfoAdditionalInfoOneOf, EmailInfo, PhoneInfo, AddressInfo, CustomFieldInfo, NestedForm, CreateCheckoutFromSubmissionResponse, IsFormSubmittableRequest, IsFormSubmittableResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, Empty, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionResponse, SubmitContactResponse, SubmissionContactMapped, SubmissionContactMappingSkipped, CreateSubmissionRequest, CreateSubmissionResponse, CreateSubmissionBySubmitterRequest, CreateSubmissionBySubmitterResponse, BulkCreateSubmissionBySubmitterRequest, BulkCreateSubmissionBySubmitterData, BulkCreateSubmissionBySubmitterResponse, BulkSubmissionResult, ItemMetadata, ApplicationError, BulkActionMetadata, GetSubmissionRequest, GetSubmissionResponse, UpdateSubmissionRequest, UpdateSubmissionResponse, ConfirmSubmissionRequest, ConfirmSubmissionResponse, FormSubmissionStatusUpdatedEvent, DeleteSubmissionRequest, DeleteSubmissionResponse, BulkDeleteSubmissionRequest, BulkDeleteSubmissionResponse, BulkDeleteSubmissionResult, RestoreSubmissionFromTrashBinRequest, RestoreSubmissionFromTrashBinResponse, RemoveSubmissionFromTrashBinRequest, RemoveSubmissionFromTrashBinResponse, RemovedSubmissionFromTrash, BulkRemoveSubmissionFromTrashBinRequest, BulkRemoveSubmissionFromTrashBinResponse, BulkRemoveSubmissionFromTrashBinResult, ListDeletedSubmissionsRequest, CursorPaging, ListDeletedSubmissionsResponse, CursorPagingMetadata, Cursors, GetDeletedSubmissionRequest, GetDeletedSubmissionResponse, QuerySubmissionRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, QuerySubmissionResponse, QuerySubmissionsByNamespaceRequest, QuerySubmissionsByNamespaceResponse, CountSubmissionsRequest, CountSubmissionsResponse, FormSubmissionsCount, CountDeletedSubmissionsRequest, CountDeletedSubmissionsResponse, FormDeletedSubmissionsCount, GetMediaUploadURLRequest, GetMediaUploadURLResponse, BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse, Task, TaskKey, TaskAction, TaskActionActionOneOf, Complete, Cancel, Reschedule, CreateSubmissionResponseNonNullableFields, GetSubmissionResponseNonNullableFields, UpdateSubmissionResponseNonNullableFields, ConfirmSubmissionResponseNonNullableFields, BulkDeleteSubmissionResponseNonNullableFields, RestoreSubmissionFromTrashBinResponseNonNullableFields, BulkRemoveSubmissionFromTrashBinResponseNonNullableFields, ListDeletedSubmissionsResponseNonNullableFields, GetDeletedSubmissionResponseNonNullableFields, QuerySubmissionsByNamespaceResponseNonNullableFields, CountSubmissionsResponseNonNullableFields, CountDeletedSubmissionsResponseNonNullableFields, GetMediaUploadURLResponseNonNullableFields, CreateSubmissionOptions, UpdateSubmission, DeleteSubmissionOptions, BulkDeleteSubmissionOptions, BulkRemoveSubmissionFromTrashBinOptions, ListDeletedSubmissionsOptions, QuerySubmissionsByNamespaceOptions, SubmissionsQueryResult, SubmissionsQueryBuilder, CountSubmissionsOptions, CountDeletedSubmissionsOptions, } from './forms-v4-submission.universal';
|
|
32
|
+
export { FormSubmission, Owner, OwnerOwnerOneOf, Submitter, SubmitterSubmitterOneOf, ExtendedFields, OrderDetails, CreateCheckoutFromSubmissionRequest, CreateCheckoutFromSubmissionRequestFormSchemaIdentifierOneOf, Form, FormField, StringType, StringTypeFormatOptionsOneOf, StringErrorMessages, DateTimeConstraints, NumberType, NumberErrorMessages, IntegerType, BooleanType, BooleanErrorMessages, ArrayType, ObjectType, PropertiesType, PropertiesTypePropertiesTypeOneOf, ObjectErrorMessages, ArrayItems, ArrayItemsItemsOneOf, ArrayErrorMessages, PredefinedValidation, PredefinedValidationFormatOptionsOneOf, PaymentType, QuantityLimit, FixedPriceOptions, DynamicPriceOptions, Product, ProductPriceOptionsOneOf, NestedFormFieldOverrides, Validation, ValidationValidationOneOf, DataExtensionsDetails, NestedFormOverrides, FormFieldV2, FormFieldV2FieldTypeOptionsOneOf, InputFieldStringType, InputFieldStringErrorMessages, TextInput, RichContent, Node, NodeDataOneOf, NodeStyle, ButtonData, Border, Colors, PluginContainerData, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Spoiler, Height, Styles, Link, LinkDataOneOf, Rel, CodeBlockData, TextStyle, DividerData, FileData, FileSource, FileSourceDataOneOf, PDFSettings, GalleryData, Media, Image, Video, Item, ItemDataOneOf, GalleryOptions, Layout, ItemStyle, Thumbnails, GIFData, GIF, HeadingData, HTMLData, HTMLDataDataOneOf, ImageData, LinkPreviewData, MapData, MapSettings, ParagraphData, PollData, Permissions, PollOption, Settings, PollLayout, OptionLayout, Gradient, Background, BackgroundBackgroundOneOf, PollDesign, OptionDesign, Poll, PollDataLayout, Design, TextData, Decoration, DecorationDataOneOf, AnchorData, ColorData, LinkData, MentionData, FontSizeData, AppEmbedData, AppEmbedDataAppDataOneOf, BookingData, EventData, VideoData, PlaybackOptions, EmbedData, Oembed, CollapsibleListData, TableData, Dimensions, TableCellData, CellStyle, BorderColors, ListValue, AudioData, OrderedListData, BulletedListData, BlockquoteData, Metadata, DocumentStyle, TextNodeStyle, RadioGroup, RadioGroupOption, RadioGroupCustomOption, Dropdown, DropdownOption, DropdownCustomOption, DateTimeInput, DateTimeInputDateTimeInputTypeOptionsOneOf, DateTimeOptions, DateOptions, TimeOptions, InputFieldNumberType, InputFieldNumberErrorMessages, NumberInput, InputFieldBooleanType, InputFieldBooleanErrorMessages, Checkbox, InputFieldArrayType, InputFieldIntegerType, InputFieldObjectType, ObjectTypePropertiesType, ObjectTypePropertiesTypePropertiesTypeOptionsOneOf, InputFieldObjectErrorMessages, ArrayTypeArrayItems, ArrayTypeArrayItemsItemTypeOptionsOneOf, InputFieldArrayErrorMessages, CheckboxGroup, MediaItem, MediaItemMediaOneOf, Option, CustomOption, FileUpload, ProductCheckboxGroup, ProductCheckboxGroupOption, _String, _StringComponentTypeOptionsOneOf, _Number, _NumberComponentTypeOptionsOneOf, _Boolean, _BooleanComponentTypeOptionsOneOf, _Array, _ArrayComponentTypeOptionsOneOf, _Object, _ObjectValidationOneOf, WixFile, WixFileComponentTypeOptionsOneOf, Payment, PaymentComponentTypeOptionsOneOf, Header, RichText, ThankYouMessage, Redirect, InputField, InputFieldInputTypeOptionsOneOf, DisplayField, DisplayFieldComponentTypeOneOf, SubmitButton, SubmitButtonSubmitActionOneOf, Step, FormLayout, BreakPoint, ItemLayout, Margin, Section, FormRule, FormOverride, FormProperties, PostSubmissionTriggers, UpsertContact, FormFieldContactInfo, FormFieldContactInfoAdditionalInfoOneOf, EmailInfo, PhoneInfo, AddressInfo, CustomFieldInfo, NestedForm, CreateCheckoutFromSubmissionResponse, IsFormSubmittableRequest, IsFormSubmittableResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, Empty, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionResponse, SubmitContactResponse, SubmissionContactMapped, SubmissionContactMappingSkipped, CreateSubmissionRequest, CreateSubmissionResponse, CreateSubmissionBySubmitterRequest, CreateSubmissionBySubmitterResponse, BulkCreateSubmissionBySubmitterRequest, BulkCreateSubmissionBySubmitterData, BulkCreateSubmissionBySubmitterResponse, BulkSubmissionResult, ItemMetadata, ApplicationError, BulkActionMetadata, GetSubmissionRequest, GetSubmissionResponse, GetSubmissionByCheckoutIdRequest, GetSubmissionByCheckoutIdResponse, UpdateSubmissionRequest, UpdateSubmissionResponse, ConfirmSubmissionRequest, ConfirmSubmissionResponse, FormSubmissionStatusUpdatedEvent, DeleteSubmissionRequest, DeleteSubmissionResponse, BulkDeleteSubmissionRequest, BulkDeleteSubmissionResponse, BulkDeleteSubmissionResult, RestoreSubmissionFromTrashBinRequest, RestoreSubmissionFromTrashBinResponse, RemoveSubmissionFromTrashBinRequest, RemoveSubmissionFromTrashBinResponse, RemovedSubmissionFromTrash, BulkRemoveSubmissionFromTrashBinRequest, BulkRemoveSubmissionFromTrashBinResponse, BulkRemoveSubmissionFromTrashBinResult, ListDeletedSubmissionsRequest, CursorPaging, ListDeletedSubmissionsResponse, CursorPagingMetadata, Cursors, GetDeletedSubmissionRequest, GetDeletedSubmissionResponse, QuerySubmissionRequest, CursorQuery, CursorQueryPagingMethodOneOf, Sorting, QuerySubmissionResponse, QuerySubmissionsByNamespaceRequest, QuerySubmissionsByNamespaceResponse, CountSubmissionsRequest, CountSubmissionsResponse, FormSubmissionsCount, CountDeletedSubmissionsRequest, CountDeletedSubmissionsResponse, FormDeletedSubmissionsCount, GetMediaUploadURLRequest, GetMediaUploadURLResponse, BulkMarkSubmissionsAsSeenRequest, BulkMarkSubmissionsAsSeenResponse, Task, TaskKey, TaskAction, TaskActionActionOneOf, Complete, Cancel, Reschedule, CreateSubmissionResponseNonNullableFields, GetSubmissionResponseNonNullableFields, UpdateSubmissionResponseNonNullableFields, ConfirmSubmissionResponseNonNullableFields, BulkDeleteSubmissionResponseNonNullableFields, RestoreSubmissionFromTrashBinResponseNonNullableFields, BulkRemoveSubmissionFromTrashBinResponseNonNullableFields, ListDeletedSubmissionsResponseNonNullableFields, GetDeletedSubmissionResponseNonNullableFields, QuerySubmissionsByNamespaceResponseNonNullableFields, CountSubmissionsResponseNonNullableFields, CountDeletedSubmissionsResponseNonNullableFields, GetMediaUploadURLResponseNonNullableFields, CreateSubmissionOptions, UpdateSubmission, DeleteSubmissionOptions, BulkDeleteSubmissionOptions, BulkRemoveSubmissionFromTrashBinOptions, ListDeletedSubmissionsOptions, QuerySubmissionsByNamespaceOptions, SubmissionsQueryResult, SubmissionsQueryBuilder, CountSubmissionsOptions, CountDeletedSubmissionsOptions, } from './forms-v4-submission.universal';
|
|
@@ -5,22 +5,22 @@ export interface FormSubmission {
|
|
|
5
5
|
* @readonly
|
|
6
6
|
*/
|
|
7
7
|
id?: string | null;
|
|
8
|
-
/** ID of the form which submission belongs to. */
|
|
8
|
+
/** ID of the form which the submission belongs to. */
|
|
9
9
|
formId?: string;
|
|
10
10
|
/**
|
|
11
|
-
* The app which the form submissions belong to. For example, the namespace for the Wix Forms
|
|
11
|
+
* 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.
|
|
12
12
|
* @readonly
|
|
13
13
|
*/
|
|
14
14
|
namespace?: string;
|
|
15
15
|
/**
|
|
16
16
|
* Status of the submission.
|
|
17
|
-
* - `PENDING`:
|
|
18
|
-
* - `PAYMENT_WAITING`:
|
|
19
|
-
* - `PAYMENT_CANCELED`:
|
|
20
|
-
* - `CONFIRMED`:
|
|
17
|
+
* - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
|
|
18
|
+
* - `PAYMENT_WAITING`: A form submission requiring payment is created.
|
|
19
|
+
* - `PAYMENT_CANCELED`: An order of a form submission is canceled.
|
|
20
|
+
* - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
|
|
21
21
|
*/
|
|
22
22
|
status?: SubmissionStatus;
|
|
23
|
-
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
23
|
+
/** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
|
|
24
24
|
submissions?: Record<string, any>;
|
|
25
25
|
/**
|
|
26
26
|
* Date and time the form submission was created.
|
|
@@ -38,15 +38,18 @@ export interface FormSubmission {
|
|
|
38
38
|
*/
|
|
39
39
|
revision?: string | null;
|
|
40
40
|
/**
|
|
41
|
-
* ID of the
|
|
41
|
+
* ID of the visitor that submitted the form.
|
|
42
42
|
* @readonly
|
|
43
43
|
*/
|
|
44
44
|
submitter?: Submitter;
|
|
45
|
-
/** Whether
|
|
45
|
+
/** Whether a site owner marked a submission as "seen". */
|
|
46
46
|
seen?: boolean;
|
|
47
|
-
/** Data
|
|
47
|
+
/** Data extension object that holds users' and apps' fields. */
|
|
48
48
|
extendedFields?: ExtendedFields;
|
|
49
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* Order details.
|
|
51
|
+
* *Note**: This object is only applicable when submittng a form in the Wix Payments app.
|
|
52
|
+
*/
|
|
50
53
|
orderDetails?: OrderDetails;
|
|
51
54
|
}
|
|
52
55
|
export declare enum SubmissionStatus {
|
|
@@ -2815,8 +2818,6 @@ export interface CreateSubmissionRequest {
|
|
|
2815
2818
|
export interface CreateSubmissionResponse {
|
|
2816
2819
|
/** The created submission. */
|
|
2817
2820
|
submission?: FormSubmission;
|
|
2818
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2819
|
-
checkoutId?: string | null;
|
|
2820
2821
|
}
|
|
2821
2822
|
export interface CreateSubmissionBySubmitterRequest {
|
|
2822
2823
|
/** Submission to create. */
|
|
@@ -2827,8 +2828,6 @@ export interface CreateSubmissionBySubmitterRequest {
|
|
|
2827
2828
|
export interface CreateSubmissionBySubmitterResponse {
|
|
2828
2829
|
/** The created submission. */
|
|
2829
2830
|
submission?: FormSubmission;
|
|
2830
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2831
|
-
checkoutId?: string | null;
|
|
2832
2831
|
}
|
|
2833
2832
|
export interface BulkCreateSubmissionBySubmitterRequest {
|
|
2834
2833
|
/** Form id. Restricts submissions creation for a single form. */
|
|
@@ -2860,8 +2859,6 @@ export interface BulkSubmissionResult {
|
|
|
2860
2859
|
itemMetadata?: ItemMetadata;
|
|
2861
2860
|
/** The created submission. */
|
|
2862
2861
|
item?: FormSubmission;
|
|
2863
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2864
|
-
checkoutId?: string | null;
|
|
2865
2862
|
}
|
|
2866
2863
|
export interface ItemMetadata {
|
|
2867
2864
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
@@ -2897,6 +2894,14 @@ export interface GetSubmissionResponse {
|
|
|
2897
2894
|
/** The retrieved submission. */
|
|
2898
2895
|
submission?: FormSubmission;
|
|
2899
2896
|
}
|
|
2897
|
+
export interface GetSubmissionByCheckoutIdRequest {
|
|
2898
|
+
/** Checkout ID of the submission to retrieve. */
|
|
2899
|
+
checkoutId?: string;
|
|
2900
|
+
}
|
|
2901
|
+
export interface GetSubmissionByCheckoutIdResponse {
|
|
2902
|
+
/** The retrieved submission. */
|
|
2903
|
+
submission?: FormSubmission;
|
|
2904
|
+
}
|
|
2900
2905
|
export interface UpdateSubmissionRequest {
|
|
2901
2906
|
/** Submission to update. */
|
|
2902
2907
|
submission: FormSubmission;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"forms-v4-submission.types.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.types.ts"],"names":[],"mappings":";;;;
|
|
1
|
+
{"version":3,"file":"forms-v4-submission.types.js","sourceRoot":"","sources":["../../../src/forms-v4-submission.types.ts"],"names":[],"mappings":";;;;AAuDA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,uDAAmC,CAAA;IACnC,yDAAqC,CAAA;AACvC,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AA4ND,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,iCAAuB,CAAA;IACvB,yBAAe,CAAA;IACf,qBAAW,CAAA;IACX,uBAAa,CAAA;IACb,yBAAe,CAAA;IACf,qBAAW,CAAA;IACX,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,+BAAqB,CAAA;IACrB,mDAAyC,CAAA;AAC3C,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AAqKD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,8BAA8B;IAC9B,yCAAqB,CAAA;IACrB,0BAA0B;IAC1B,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B;AAWD,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,4BAA4B;IAC5B,sCAAuB,CAAA;IACvB,eAAe;IACf,kCAAmB,CAAA;AACrB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AAED,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,mBAAmB;IACnB,wCAA2B,CAAA;IAC3B,sCAAsC;IACtC,4CAA+B,CAAA;AACjC,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AAqJD,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,iCAAa,CAAA;IACb,iCAAa,CAAA;IACb,2CAAuB,CAAA;IACvB,mCAAe,CAAA;IACf,+BAAW,CAAA;IACX,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,+BAAW,CAAA;IACX,yCAAqB,CAAA;IACrB,2CAAuB,CAAA;IACvB,yCAAqB,CAAA;IACrB,yCAAqB,CAAA;IACrB,6DAAyC,CAAA;AAC3C,CAAC,EAfW,gBAAgB,gCAAhB,gBAAgB,QAe3B;AAOD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,gDAAyB,CAAA;IACzB,kDAA2B,CAAA;IAC3B,4CAAqB,CAAA;IACrB,8CAAuB,CAAA;AACzB,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA4ID,IAAY,QA+BX;AA/BD,WAAY,QAAQ;IAClB,mCAAuB,CAAA;IACvB,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,2CAA+B,CAAA;IAC/B,yCAA6B,CAAA;IAC7B,mCAAuB,CAAA;IACvB,qCAAyB,CAAA;IACzB,qCAAyB,CAAA;IACzB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,yCAA6B,CAAA;IAC7B,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,mCAAuB,CAAA;IACvB,6BAAiB,CAAA;IACjB,iDAAqC,CAAA;IACrC,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,iDAAqC,CAAA;IACrC,6DAAiD,CAAA;IACjD,2DAA+C,CAAA;IAC/C,qCAAyB,CAAA;IACzB,mCAAuB,CAAA;IACvB,iCAAqB,CAAA;IACrB,2BAAe,CAAA;AACjB,CAAC,EA/BW,QAAQ,wBAAR,QAAQ,QA+BnB;AAqDD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,sCAAsC;IACtC,gCAAmB,CAAA;IACnB,kBAAkB;IAClB,4BAAe,CAAA;IACf,gDAAgD;IAChD,kCAAqB,CAAA;IACrB,6BAA6B;IAC7B,sCAAyB,CAAA;AAC3B,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AA8BD,IAAY,4BAOX;AAPD,WAAY,4BAA4B;IACtC,uBAAuB;IACvB,iDAAiB,CAAA;IACjB,qBAAqB;IACrB,6CAAa,CAAA;IACb,sBAAsB;IACtB,+CAAe,CAAA;AACjB,CAAC,EAPW,4BAA4B,4CAA5B,4BAA4B,QAOvC;AAgBD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,0BAA0B;IAC1B,qBAAa,CAAA;IACb,qFAAqF;IACrF,yBAAiB,CAAA;AACnB,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAoCD,IAAY,UASX;AATD,WAAY,UAAU;IACpB,sFAAsF;IACtF,2BAAa,CAAA;IACb,uDAAuD;IACvD,6BAAe,CAAA;IACf,oDAAoD;IACpD,+BAAiB,CAAA;IACjB,+DAA+D;IAC/D,yBAAW,CAAA;AACb,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAyBD,IAAY,aAWX;AAXD,WAAY,aAAa;IACvB,8CAA8C;IAC9C,8BAAa,CAAA;IACb,iBAAiB;IACjB,8BAAa,CAAA;IACb,kBAAkB;IAClB,gCAAe,CAAA;IACf,mBAAmB;IACnB,kCAAiB,CAAA;IACjB,gIAAgI;IAChI,oCAAmB,CAAA;AACrB,CAAC,EAXW,aAAa,6BAAb,aAAa,QAWxB;AAaD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;IACjB,kBAAkB;IAClB,8BAAiB,CAAA;AACnB,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AAED,IAAY,KAOX;AAPD,WAAY,KAAK;IACf,iBAAiB;IACjB,wBAAe,CAAA;IACf,kBAAkB;IAClB,0BAAiB,CAAA;IACjB,iBAAiB;IACjB,wBAAe,CAAA;AACjB,CAAC,EAPW,KAAK,qBAAL,KAAK,QAOhB;AAED,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,uBAAuB;IACvB,8BAAiB,CAAA;IACjB,qBAAqB;IACrB,0BAAa,CAAA;IACb,sBAAsB;IACtB,4BAAe,CAAA;AACjB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAqBD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,kBAAkB;IAClB,yBAAa,CAAA;IACb,oBAAoB;IACpB,yBAAa,CAAA;IACb,oBAAoB;IACpB,yBAAa,CAAA;AACf,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAuGD,IAAY,UAqBX;AArBD,WAAY,UAAU;IACpB,mBAAmB;IACnB,iCAAmB,CAAA;IACnB,mBAAmB;IACnB,iCAAmB,CAAA;IACnB,gBAAgB;IAChB,2BAAa,CAAA;IACb,qBAAqB;IACrB,qCAAuB,CAAA;IACvB,kBAAkB;IAClB,+BAAiB,CAAA;IACjB,qBAAqB;IACrB,qCAAuB,CAAA;IACvB,oBAAoB;IACpB,mCAAqB,CAAA;IACrB,kBAAkB;IAClB,+BAAiB,CAAA;IACjB,iBAAiB;IACjB,6BAAe,CAAA;IACf,2BAA2B;IAC3B,mCAAqB,CAAA;AACvB,CAAC,EArBW,UAAU,0BAAV,UAAU,QAqBrB;AAED,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,uBAAuB;IACvB,4BAAa,CAAA;IACb,0BAA0B;IAC1B,kCAAmB,CAAA;AACrB,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAED,IAAY,IAKX;AALD,WAAY,IAAI;IACd,mBAAmB;IACnB,qBAAa,CAAA;IACb,kBAAkB;IAClB,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAED,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,oBAAoB;IACpB,kCAAW,CAAA;IACX,sBAAsB;IACtB,sCAAe,CAAA;IACf,uBAAuB;IACvB,wCAAiB,CAAA;IACjB,qBAAqB;IACrB,oCAAa,CAAA;IACb,mBAAmB;IACnB,oCAAa,CAAA;AACf,CAAC,EAXW,mBAAmB,mCAAnB,mBAAmB,QAW9B;AAuFD,IAAY,MAGX;AAHD,WAAY,MAAM;IAChB,uBAAa,CAAA;IACb,6BAAmB,CAAA;AACrB,CAAC,EAHW,MAAM,sBAAN,MAAM,QAGjB;AAkED,IAAY,OASX;AATD,WAAY,OAAO;IACjB,uBAAuB;IACvB,8BAAmB,CAAA;IACnB,yBAAyB;IACzB,gCAAqB,CAAA;IACrB,sBAAsB;IACtB,4BAAiB,CAAA;IACjB,uBAAuB;IACvB,8BAAmB,CAAA;AACrB,CAAC,EATW,OAAO,uBAAP,OAAO,QASlB;AAoBD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,6CAA6C;IAC7C,+BAAmB,CAAA;IACnB,2CAA2C;IAC3C,6BAAiB,CAAA;IACjB,0DAA0D;IAC1D,iCAAqB,CAAA;AACvB,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAED,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,uBAAuB;IACvB,yCAA6B,CAAA;IAC7B,aAAa;IACb,uBAAW,CAAA;AACb,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AA6BD,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,WAAW;IACX,+BAAa,CAAA;IACb,WAAW;IACX,+BAAa,CAAA;AACf,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAED,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,oBAAoB;IACpB,kCAAW,CAAA;IACX,oBAAoB;IACpB,kCAAW,CAAA;AACb,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAgBD,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,4BAA4B;IAC5B,iCAAe,CAAA;IACf,4BAA4B;IAC5B,iCAAe,CAAA;IACf,+BAA+B;IAC/B,uCAAqB,CAAA;AACvB,CAAC,EAPW,cAAc,8BAAd,cAAc,QAOzB;AA0HD,IAAY,cAWX;AAXD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;IACnB,+BAAa,CAAA;IACb,iCAAe,CAAA;IACf,yCAAuB,CAAA;IACvB,uCAAqB,CAAA;AACvB,CAAC,EAXW,cAAc,8BAAd,cAAc,QAWzB;AAmCD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,qBAAS,CAAA;IACT,qBAAS,CAAA;AACX,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB;AA6BD,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,0BAAe,CAAA;IACf,8BAAmB,CAAA;AACrB,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB;AA6FD,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,2CAA2C;IAC3C,uCAAe,CAAA;IACf,uCAAuC;IACvC,mCAAW,CAAA;IACX,mCAAmC;IACnC,qCAAa,CAAA;AACf,CAAC,EAPW,oBAAoB,oCAApB,oBAAoB,QAO/B;AAED,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oBAAoB;IACpB,wBAAW,CAAA;IACX,oBAAoB;IACpB,wBAAW,CAAA;AACb,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA+BD,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,oBAAoB;IACpB,gCAAW,CAAA;IACX,uBAAuB;IACvB,sCAAiB,CAAA;IACjB,uBAAuB;IACvB,sCAAiB,CAAA;AACnB,CAAC,EAPW,iBAAiB,iCAAjB,iBAAiB,QAO5B;AAoBD;;;;;GAKG;AACH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,kBAAkB;IAClB,sCAAyB,CAAA;AAC3B,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAwMD,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,iCAAe,CAAA;IACf,6BAAW,CAAA;AACb,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAED,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,+BAA+B;IAC/B,4CAAuB,CAAA;IACvB,2BAA2B;IAC3B,kCAAa,CAAA;IACb,2BAA2B;IAC3B,kCAAa,CAAA;AACf,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AA2CD,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,oDAA6B,CAAA;AAC/B,CAAC,EAHW,mBAAmB,mCAAnB,mBAAmB,QAG9B;AA4BD,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,6CAAqB,CAAA;AACvB,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAkBD,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,+BAAmB,CAAA;IACnB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,+BAAmB,CAAA;IACnB,+BAAmB,CAAA;IACnB,6BAAiB,CAAA;AACnB,CAAC,EAPW,QAAQ,wBAAR,QAAQ,QAOnB;AAsBD,IAAY,4BAOX;AAPD,WAAY,4BAA4B;IACtC,mDAAmB,CAAA;IACnB,iDAAiB,CAAA;IACjB,iDAAiB,CAAA;IACjB,mDAAmB,CAAA;IACnB,mDAAmB,CAAA;IACnB,+CAAe,CAAA;AACjB,CAAC,EAPW,4BAA4B,4CAA5B,4BAA4B,QAOvC;AAgFD,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,kDAAiC,CAAA;AACnC,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAyED,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,mDAA2B,CAAA;AAC7B,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAsBD,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,kBAAkB;IAClB,mCAAe,CAAA;IACf,kBAAkB;IAClB,mCAAe,CAAA;IACf,kBAAkB;IAClB,mCAAe,CAAA;IACf,qBAAqB;IACrB,yCAAqB,CAAA;AACvB,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AAED,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,2CAAmB,CAAA;IACnB,yDAAiC,CAAA;AACnC,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAsBD,IAAY,SASX;AATD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;AACrB,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AA6ID,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,iCAAiC;IACjC,uBAAa,CAAA;IACb,0BAA0B;IAC1B,yBAAe,CAAA;AACjB,CAAC,EANW,MAAM,sBAAN,MAAM,QAMjB;AAmBD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA8KD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,qCAAe,CAAA;IACf,mCAAa,CAAA;IACb,6DAAuC,CAAA;AACzC,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAkBD,IAAY,IAGX;AAHD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,+BAAuB,CAAA;AACzB,CAAC,EAHW,IAAI,oBAAJ,IAAI,QAGf;AA4CD,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;AACf,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,6BAAa,CAAA;AACf,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAED,IAAY,GAGX;AAHD,WAAY,GAAG;IACb,4BAAqB,CAAA;IACrB,oBAAa,CAAA;AACf,CAAC,EAHW,GAAG,mBAAH,GAAG,QAGd;AAED,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,yCAAyB,CAAA;IACzB,uCAAuB,CAAA;IACvB,mCAAmB,CAAA;IACnB,qCAAqB,CAAA;IACrB,+BAAe,CAAA;IACf,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,uCAAuB,CAAA;IACvB,6CAA6B,CAAA;IAC7B,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AAmJD,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,kDAAkD;IAClD,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qEAAqD,CAAA;AACvD,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AA6UD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}
|
|
@@ -11,22 +11,22 @@ export interface FormSubmission {
|
|
|
11
11
|
* @readonly
|
|
12
12
|
*/
|
|
13
13
|
_id?: string | null;
|
|
14
|
-
/** ID of the form which submission belongs to. */
|
|
14
|
+
/** ID of the form which the submission belongs to. */
|
|
15
15
|
formId?: string;
|
|
16
16
|
/**
|
|
17
|
-
* The app which the form submissions belong to. For example, the namespace for the Wix Forms
|
|
17
|
+
* 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.
|
|
18
18
|
* @readonly
|
|
19
19
|
*/
|
|
20
20
|
namespace?: string;
|
|
21
21
|
/**
|
|
22
22
|
* Status of the submission.
|
|
23
|
-
* - `PENDING`:
|
|
24
|
-
* - `PAYMENT_WAITING`:
|
|
25
|
-
* - `PAYMENT_CANCELED`:
|
|
26
|
-
* - `CONFIRMED`:
|
|
23
|
+
* - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
|
|
24
|
+
* - `PAYMENT_WAITING`: A form submission requiring payment is created.
|
|
25
|
+
* - `PAYMENT_CANCELED`: An order of a form submission is canceled.
|
|
26
|
+
* - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
|
|
27
27
|
*/
|
|
28
28
|
status?: SubmissionStatus;
|
|
29
|
-
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
29
|
+
/** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
|
|
30
30
|
submissions?: Record<string, any>;
|
|
31
31
|
/**
|
|
32
32
|
* Date and time the form submission was created.
|
|
@@ -44,15 +44,18 @@ export interface FormSubmission {
|
|
|
44
44
|
*/
|
|
45
45
|
revision?: string | null;
|
|
46
46
|
/**
|
|
47
|
-
* ID of the
|
|
47
|
+
* ID of the visitor that submitted the form.
|
|
48
48
|
* @readonly
|
|
49
49
|
*/
|
|
50
50
|
submitter?: Submitter;
|
|
51
|
-
/** Whether
|
|
51
|
+
/** Whether a site owner marked a submission as "seen". */
|
|
52
52
|
seen?: boolean;
|
|
53
|
-
/** Data
|
|
53
|
+
/** Data extension object that holds users' and apps' fields. */
|
|
54
54
|
extendedFields?: ExtendedFields;
|
|
55
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* Order details.
|
|
57
|
+
* *Note**: This object is only applicable when submittng a form in the Wix Payments app.
|
|
58
|
+
*/
|
|
56
59
|
orderDetails?: OrderDetails;
|
|
57
60
|
}
|
|
58
61
|
export declare enum SubmissionStatus {
|
|
@@ -2798,8 +2801,6 @@ export interface CreateSubmissionRequest {
|
|
|
2798
2801
|
export interface CreateSubmissionResponse {
|
|
2799
2802
|
/** The created submission. */
|
|
2800
2803
|
submission?: FormSubmission;
|
|
2801
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2802
|
-
checkoutId?: string | null;
|
|
2803
2804
|
}
|
|
2804
2805
|
export interface CreateSubmissionBySubmitterRequest {
|
|
2805
2806
|
/** Submission to create. */
|
|
@@ -2810,8 +2811,6 @@ export interface CreateSubmissionBySubmitterRequest {
|
|
|
2810
2811
|
export interface CreateSubmissionBySubmitterResponse {
|
|
2811
2812
|
/** The created submission. */
|
|
2812
2813
|
submission?: FormSubmission;
|
|
2813
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2814
|
-
checkoutId?: string | null;
|
|
2815
2814
|
}
|
|
2816
2815
|
export interface BulkCreateSubmissionBySubmitterRequest {
|
|
2817
2816
|
/** Form id. Restricts submissions creation for a single form. */
|
|
@@ -2843,8 +2842,6 @@ export interface BulkSubmissionResult {
|
|
|
2843
2842
|
itemMetadata?: ItemMetadata;
|
|
2844
2843
|
/** The created submission. */
|
|
2845
2844
|
item?: FormSubmission;
|
|
2846
|
-
/** Checkout ID (applicable for form involving payments). */
|
|
2847
|
-
checkoutId?: string | null;
|
|
2848
2845
|
}
|
|
2849
2846
|
export interface ItemMetadata {
|
|
2850
2847
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
@@ -2880,6 +2877,14 @@ export interface GetSubmissionResponse {
|
|
|
2880
2877
|
/** The retrieved submission. */
|
|
2881
2878
|
submission?: FormSubmission;
|
|
2882
2879
|
}
|
|
2880
|
+
export interface GetSubmissionByCheckoutIdRequest {
|
|
2881
|
+
/** Checkout ID of the submission to retrieve. */
|
|
2882
|
+
checkoutId?: string;
|
|
2883
|
+
}
|
|
2884
|
+
export interface GetSubmissionByCheckoutIdResponse {
|
|
2885
|
+
/** The retrieved submission. */
|
|
2886
|
+
submission?: FormSubmission;
|
|
2887
|
+
}
|
|
2883
2888
|
export interface UpdateSubmissionRequest {
|
|
2884
2889
|
/** Submission to update. */
|
|
2885
2890
|
submission: FormSubmission;
|
|
@@ -3351,9 +3356,8 @@ export interface CreateSubmissionOptions {
|
|
|
3351
3356
|
* @permissionScope Read Orders
|
|
3352
3357
|
* @permissionScope Read Submissions
|
|
3353
3358
|
* @applicableIdentity APP
|
|
3354
|
-
* @returns The retrieved submission.
|
|
3355
3359
|
*/
|
|
3356
|
-
export declare function getSubmission(submissionId: string): Promise<
|
|
3360
|
+
export declare function getSubmission(submissionId: string): Promise<GetSubmissionResponse & GetSubmissionResponseNonNullableFields>;
|
|
3357
3361
|
/**
|
|
3358
3362
|
* Updates a submission.
|
|
3359
3363
|
* > **Note**:
|
|
@@ -3380,22 +3384,22 @@ export interface UpdateSubmission {
|
|
|
3380
3384
|
* @readonly
|
|
3381
3385
|
*/
|
|
3382
3386
|
_id?: string | null;
|
|
3383
|
-
/** ID of the form which submission belongs to. */
|
|
3387
|
+
/** ID of the form which the submission belongs to. */
|
|
3384
3388
|
formId?: string;
|
|
3385
3389
|
/**
|
|
3386
|
-
* The app which the form submissions belong to. For example, the namespace for the Wix Forms
|
|
3390
|
+
* 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.
|
|
3387
3391
|
* @readonly
|
|
3388
3392
|
*/
|
|
3389
3393
|
namespace?: string;
|
|
3390
3394
|
/**
|
|
3391
3395
|
* Status of the submission.
|
|
3392
|
-
* - `PENDING`:
|
|
3393
|
-
* - `PAYMENT_WAITING`:
|
|
3394
|
-
* - `PAYMENT_CANCELED`:
|
|
3395
|
-
* - `CONFIRMED`:
|
|
3396
|
+
* - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
|
|
3397
|
+
* - `PAYMENT_WAITING`: A form submission requiring payment is created.
|
|
3398
|
+
* - `PAYMENT_CANCELED`: An order of a form submission is canceled.
|
|
3399
|
+
* - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
|
|
3396
3400
|
*/
|
|
3397
3401
|
status?: SubmissionStatus;
|
|
3398
|
-
/** Submission values where key is the form field and value is the data submitted for the given field. */
|
|
3402
|
+
/** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
|
|
3399
3403
|
submissions?: Record<string, any>;
|
|
3400
3404
|
/**
|
|
3401
3405
|
* Date and time the form submission was created.
|
|
@@ -3413,15 +3417,18 @@ export interface UpdateSubmission {
|
|
|
3413
3417
|
*/
|
|
3414
3418
|
revision?: string | null;
|
|
3415
3419
|
/**
|
|
3416
|
-
* ID of the
|
|
3420
|
+
* ID of the visitor that submitted the form.
|
|
3417
3421
|
* @readonly
|
|
3418
3422
|
*/
|
|
3419
3423
|
submitter?: Submitter;
|
|
3420
|
-
/** Whether
|
|
3424
|
+
/** Whether a site owner marked a submission as "seen". */
|
|
3421
3425
|
seen?: boolean;
|
|
3422
|
-
/** Data
|
|
3426
|
+
/** Data extension object that holds users' and apps' fields. */
|
|
3423
3427
|
extendedFields?: ExtendedFields;
|
|
3424
|
-
/**
|
|
3428
|
+
/**
|
|
3429
|
+
* Order details.
|
|
3430
|
+
* *Note**: This object is only applicable when submittng a form in the Wix Payments app.
|
|
3431
|
+
*/
|
|
3425
3432
|
orderDetails?: OrderDetails;
|
|
3426
3433
|
}
|
|
3427
3434
|
/**
|