@wix/forms 1.0.112 → 1.0.114
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.
|
@@ -71,6 +71,8 @@ interface Form$1 {
|
|
|
71
71
|
spamFilterProtectionLevel?: SpamFilterProtectionLevel$1;
|
|
72
72
|
/** Required indicator properties. */
|
|
73
73
|
requiredIndicatorProperties?: RequiredIndicatorProperties$1;
|
|
74
|
+
/** Settings for actions to be taken after form submission. */
|
|
75
|
+
submitSettings?: SubmitSettings$1;
|
|
74
76
|
}
|
|
75
77
|
declare enum RequiredIndicator$1 {
|
|
76
78
|
UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
|
|
@@ -2690,9 +2692,19 @@ interface DisplayFieldComponentTypeOneOf$1 {
|
|
|
2690
2692
|
richText?: RichText$1;
|
|
2691
2693
|
}
|
|
2692
2694
|
interface SubmitButton$1 extends SubmitButtonSubmitActionOneOf$1 {
|
|
2693
|
-
/**
|
|
2695
|
+
/**
|
|
2696
|
+
* Submit action effect is to show message
|
|
2697
|
+
* @deprecated Submit action effect is to show message
|
|
2698
|
+
* @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions
|
|
2699
|
+
* @targetRemovalDate 2025-01-06
|
|
2700
|
+
*/
|
|
2694
2701
|
thankYouMessage?: ThankYouMessage$1;
|
|
2695
|
-
/**
|
|
2702
|
+
/**
|
|
2703
|
+
* Submit action effect is to redirect to
|
|
2704
|
+
* @deprecated Submit action effect is to redirect to
|
|
2705
|
+
* @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions
|
|
2706
|
+
* @targetRemovalDate 2025-01-06
|
|
2707
|
+
*/
|
|
2696
2708
|
redirect?: Redirect$1;
|
|
2697
2709
|
/** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
|
|
2698
2710
|
nextText?: string | null;
|
|
@@ -2703,9 +2715,19 @@ interface SubmitButton$1 extends SubmitButtonSubmitActionOneOf$1 {
|
|
|
2703
2715
|
}
|
|
2704
2716
|
/** @oneof */
|
|
2705
2717
|
interface SubmitButtonSubmitActionOneOf$1 {
|
|
2706
|
-
/**
|
|
2718
|
+
/**
|
|
2719
|
+
* Submit action effect is to show message
|
|
2720
|
+
* @deprecated Submit action effect is to show message
|
|
2721
|
+
* @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions
|
|
2722
|
+
* @targetRemovalDate 2025-01-06
|
|
2723
|
+
*/
|
|
2707
2724
|
thankYouMessage?: ThankYouMessage$1;
|
|
2708
|
-
/**
|
|
2725
|
+
/**
|
|
2726
|
+
* Submit action effect is to redirect to
|
|
2727
|
+
* @deprecated Submit action effect is to redirect to
|
|
2728
|
+
* @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions
|
|
2729
|
+
* @targetRemovalDate 2025-01-06
|
|
2730
|
+
*/
|
|
2709
2731
|
redirect?: Redirect$1;
|
|
2710
2732
|
}
|
|
2711
2733
|
interface Step$1 {
|
|
@@ -2855,6 +2877,49 @@ interface RequiredIndicatorProperties$1 {
|
|
|
2855
2877
|
/** Required indicator placement. */
|
|
2856
2878
|
requiredIndicatorPlacement?: RequiredIndicatorPlacement$1;
|
|
2857
2879
|
}
|
|
2880
|
+
interface SubmitSettings$1 extends SubmitSettingsSubmitSuccessActionOptionsOneOf$1 {
|
|
2881
|
+
/** Options for showing a thank you message after submission. */
|
|
2882
|
+
thankYouMessageOptions?: ThankYouMessageOptions$1;
|
|
2883
|
+
/** Options for redirecting to a URL after submission. */
|
|
2884
|
+
redirectOptions?: RedirectOptions$1;
|
|
2885
|
+
/** Action that is triggered after a successful form submission. */
|
|
2886
|
+
submitSuccessAction?: SubmitSuccessAction$1;
|
|
2887
|
+
}
|
|
2888
|
+
/** @oneof */
|
|
2889
|
+
interface SubmitSettingsSubmitSuccessActionOptionsOneOf$1 {
|
|
2890
|
+
/** Options for showing a thank you message after submission. */
|
|
2891
|
+
thankYouMessageOptions?: ThankYouMessageOptions$1;
|
|
2892
|
+
/** Options for redirecting to a URL after submission. */
|
|
2893
|
+
redirectOptions?: RedirectOptions$1;
|
|
2894
|
+
}
|
|
2895
|
+
declare enum UrlTargetEnumTarget$1 {
|
|
2896
|
+
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
2897
|
+
/** Open in the same browser tab. */
|
|
2898
|
+
SELF = "SELF",
|
|
2899
|
+
/** Open in a new browser tab. */
|
|
2900
|
+
BLANK = "BLANK"
|
|
2901
|
+
}
|
|
2902
|
+
declare enum SubmitSuccessAction$1 {
|
|
2903
|
+
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
2904
|
+
/** No action will be taken after submission. */
|
|
2905
|
+
NO_ACTION = "NO_ACTION",
|
|
2906
|
+
/** A thank you message will be shown after submission. */
|
|
2907
|
+
THANK_YOU_MESSAGE = "THANK_YOU_MESSAGE",
|
|
2908
|
+
/** The user will be redirected to a URL after submission. */
|
|
2909
|
+
REDIRECT = "REDIRECT"
|
|
2910
|
+
}
|
|
2911
|
+
interface ThankYouMessageOptions$1 {
|
|
2912
|
+
/** The message shown after form submission. */
|
|
2913
|
+
messageContent?: RichContent$1;
|
|
2914
|
+
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
2915
|
+
durationInSeconds?: number | null;
|
|
2916
|
+
}
|
|
2917
|
+
interface RedirectOptions$1 {
|
|
2918
|
+
/** The URL to which the user should be redirected after a successful form submission. */
|
|
2919
|
+
redirectUrl?: string | null;
|
|
2920
|
+
/** How the URL should be opened. */
|
|
2921
|
+
target?: UrlTargetEnumTarget$1;
|
|
2922
|
+
}
|
|
2858
2923
|
interface CreateFormRequest$1 {
|
|
2859
2924
|
/** Form to be created. */
|
|
2860
2925
|
form: Form$1;
|
|
@@ -3778,6 +3843,17 @@ interface RequiredIndicatorPropertiesNonNullableFields$1 {
|
|
|
3778
3843
|
requiredIndicator: RequiredIndicator$1;
|
|
3779
3844
|
requiredIndicatorPlacement: RequiredIndicatorPlacement$1;
|
|
3780
3845
|
}
|
|
3846
|
+
interface ThankYouMessageOptionsNonNullableFields$1 {
|
|
3847
|
+
messageContent?: RichContentNonNullableFields$1;
|
|
3848
|
+
}
|
|
3849
|
+
interface RedirectOptionsNonNullableFields$1 {
|
|
3850
|
+
target: UrlTargetEnumTarget$1;
|
|
3851
|
+
}
|
|
3852
|
+
interface SubmitSettingsNonNullableFields$1 {
|
|
3853
|
+
thankYouMessageOptions?: ThankYouMessageOptionsNonNullableFields$1;
|
|
3854
|
+
redirectOptions?: RedirectOptionsNonNullableFields$1;
|
|
3855
|
+
submitSuccessAction: SubmitSuccessAction$1;
|
|
3856
|
+
}
|
|
3781
3857
|
interface FormNonNullableFields$1 {
|
|
3782
3858
|
fields: FormFieldNonNullableFields$1[];
|
|
3783
3859
|
fieldsV2: FormFieldV2NonNullableFields$1[];
|
|
@@ -3792,6 +3868,7 @@ interface FormNonNullableFields$1 {
|
|
|
3792
3868
|
nestedForms: NestedFormNonNullableFields$1[];
|
|
3793
3869
|
spamFilterProtectionLevel: SpamFilterProtectionLevel$1;
|
|
3794
3870
|
requiredIndicatorProperties?: RequiredIndicatorPropertiesNonNullableFields$1;
|
|
3871
|
+
submitSettings?: SubmitSettingsNonNullableFields$1;
|
|
3795
3872
|
}
|
|
3796
3873
|
interface CreateFormResponseNonNullableFields$1 {
|
|
3797
3874
|
form?: FormNonNullableFields$1;
|
|
@@ -3928,6 +4005,8 @@ interface Form {
|
|
|
3928
4005
|
spamFilterProtectionLevel?: SpamFilterProtectionLevel;
|
|
3929
4006
|
/** Required indicator properties. */
|
|
3930
4007
|
requiredIndicatorProperties?: RequiredIndicatorProperties;
|
|
4008
|
+
/** Settings for actions to be taken after form submission. */
|
|
4009
|
+
submitSettings?: SubmitSettings;
|
|
3931
4010
|
}
|
|
3932
4011
|
declare enum RequiredIndicator {
|
|
3933
4012
|
UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
|
|
@@ -6524,9 +6603,19 @@ interface DisplayFieldComponentTypeOneOf {
|
|
|
6524
6603
|
richText?: RichText;
|
|
6525
6604
|
}
|
|
6526
6605
|
interface SubmitButton extends SubmitButtonSubmitActionOneOf {
|
|
6527
|
-
/**
|
|
6606
|
+
/**
|
|
6607
|
+
* Submit action effect is to show message
|
|
6608
|
+
* @deprecated Submit action effect is to show message
|
|
6609
|
+
* @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions
|
|
6610
|
+
* @targetRemovalDate 2025-01-06
|
|
6611
|
+
*/
|
|
6528
6612
|
thankYouMessage?: ThankYouMessage;
|
|
6529
|
-
/**
|
|
6613
|
+
/**
|
|
6614
|
+
* Submit action effect is to redirect to
|
|
6615
|
+
* @deprecated Submit action effect is to redirect to
|
|
6616
|
+
* @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions
|
|
6617
|
+
* @targetRemovalDate 2025-01-06
|
|
6618
|
+
*/
|
|
6530
6619
|
redirect?: Redirect;
|
|
6531
6620
|
/** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */
|
|
6532
6621
|
nextText?: string | null;
|
|
@@ -6537,9 +6626,19 @@ interface SubmitButton extends SubmitButtonSubmitActionOneOf {
|
|
|
6537
6626
|
}
|
|
6538
6627
|
/** @oneof */
|
|
6539
6628
|
interface SubmitButtonSubmitActionOneOf {
|
|
6540
|
-
/**
|
|
6629
|
+
/**
|
|
6630
|
+
* Submit action effect is to show message
|
|
6631
|
+
* @deprecated Submit action effect is to show message
|
|
6632
|
+
* @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions
|
|
6633
|
+
* @targetRemovalDate 2025-01-06
|
|
6634
|
+
*/
|
|
6541
6635
|
thankYouMessage?: ThankYouMessage;
|
|
6542
|
-
/**
|
|
6636
|
+
/**
|
|
6637
|
+
* Submit action effect is to redirect to
|
|
6638
|
+
* @deprecated Submit action effect is to redirect to
|
|
6639
|
+
* @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions
|
|
6640
|
+
* @targetRemovalDate 2025-01-06
|
|
6641
|
+
*/
|
|
6543
6642
|
redirect?: Redirect;
|
|
6544
6643
|
}
|
|
6545
6644
|
interface Step {
|
|
@@ -6689,6 +6788,49 @@ interface RequiredIndicatorProperties {
|
|
|
6689
6788
|
/** Required indicator placement. */
|
|
6690
6789
|
requiredIndicatorPlacement?: RequiredIndicatorPlacement;
|
|
6691
6790
|
}
|
|
6791
|
+
interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
6792
|
+
/** Options for showing a thank you message after submission. */
|
|
6793
|
+
thankYouMessageOptions?: ThankYouMessageOptions;
|
|
6794
|
+
/** Options for redirecting to a URL after submission. */
|
|
6795
|
+
redirectOptions?: RedirectOptions;
|
|
6796
|
+
/** Action that is triggered after a successful form submission. */
|
|
6797
|
+
submitSuccessAction?: SubmitSuccessAction;
|
|
6798
|
+
}
|
|
6799
|
+
/** @oneof */
|
|
6800
|
+
interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
|
|
6801
|
+
/** Options for showing a thank you message after submission. */
|
|
6802
|
+
thankYouMessageOptions?: ThankYouMessageOptions;
|
|
6803
|
+
/** Options for redirecting to a URL after submission. */
|
|
6804
|
+
redirectOptions?: RedirectOptions;
|
|
6805
|
+
}
|
|
6806
|
+
declare enum UrlTargetEnumTarget {
|
|
6807
|
+
UNKNOWN_TARGET = "UNKNOWN_TARGET",
|
|
6808
|
+
/** Open in the same browser tab. */
|
|
6809
|
+
SELF = "SELF",
|
|
6810
|
+
/** Open in a new browser tab. */
|
|
6811
|
+
BLANK = "BLANK"
|
|
6812
|
+
}
|
|
6813
|
+
declare enum SubmitSuccessAction {
|
|
6814
|
+
UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
|
|
6815
|
+
/** No action will be taken after submission. */
|
|
6816
|
+
NO_ACTION = "NO_ACTION",
|
|
6817
|
+
/** A thank you message will be shown after submission. */
|
|
6818
|
+
THANK_YOU_MESSAGE = "THANK_YOU_MESSAGE",
|
|
6819
|
+
/** The user will be redirected to a URL after submission. */
|
|
6820
|
+
REDIRECT = "REDIRECT"
|
|
6821
|
+
}
|
|
6822
|
+
interface ThankYouMessageOptions {
|
|
6823
|
+
/** The message shown after form submission. */
|
|
6824
|
+
messageContent?: RichContent;
|
|
6825
|
+
/** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */
|
|
6826
|
+
durationInSeconds?: number | null;
|
|
6827
|
+
}
|
|
6828
|
+
interface RedirectOptions {
|
|
6829
|
+
/** The URL to which the user should be redirected after a successful form submission. */
|
|
6830
|
+
redirectUrl?: string | null;
|
|
6831
|
+
/** How the URL should be opened. */
|
|
6832
|
+
target?: UrlTargetEnumTarget;
|
|
6833
|
+
}
|
|
6692
6834
|
interface CreateFormRequest {
|
|
6693
6835
|
/** Form to be created. */
|
|
6694
6836
|
form: Form;
|
|
@@ -7606,6 +7748,17 @@ interface RequiredIndicatorPropertiesNonNullableFields {
|
|
|
7606
7748
|
requiredIndicator: RequiredIndicator;
|
|
7607
7749
|
requiredIndicatorPlacement: RequiredIndicatorPlacement;
|
|
7608
7750
|
}
|
|
7751
|
+
interface ThankYouMessageOptionsNonNullableFields {
|
|
7752
|
+
messageContent?: RichContentNonNullableFields;
|
|
7753
|
+
}
|
|
7754
|
+
interface RedirectOptionsNonNullableFields {
|
|
7755
|
+
target: UrlTargetEnumTarget;
|
|
7756
|
+
}
|
|
7757
|
+
interface SubmitSettingsNonNullableFields {
|
|
7758
|
+
thankYouMessageOptions?: ThankYouMessageOptionsNonNullableFields;
|
|
7759
|
+
redirectOptions?: RedirectOptionsNonNullableFields;
|
|
7760
|
+
submitSuccessAction: SubmitSuccessAction;
|
|
7761
|
+
}
|
|
7609
7762
|
interface FormNonNullableFields {
|
|
7610
7763
|
fields: FormFieldNonNullableFields[];
|
|
7611
7764
|
fieldsV2: FormFieldV2NonNullableFields[];
|
|
@@ -7620,6 +7773,7 @@ interface FormNonNullableFields {
|
|
|
7620
7773
|
nestedForms: NestedFormNonNullableFields[];
|
|
7621
7774
|
spamFilterProtectionLevel: SpamFilterProtectionLevel;
|
|
7622
7775
|
requiredIndicatorProperties?: RequiredIndicatorPropertiesNonNullableFields;
|
|
7776
|
+
submitSettings?: SubmitSettingsNonNullableFields;
|
|
7623
7777
|
}
|
|
7624
7778
|
interface CreateFormResponseNonNullableFields {
|
|
7625
7779
|
form?: FormNonNullableFields;
|
|
@@ -7844,7 +7998,7 @@ interface ExtendedFields$3 {
|
|
|
7844
7998
|
namespaces?: Record<string, Record<string, any>>;
|
|
7845
7999
|
}
|
|
7846
8000
|
declare enum SubmissionStatus$3 {
|
|
7847
|
-
|
|
8001
|
+
UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
|
|
7848
8002
|
PENDING = "PENDING",
|
|
7849
8003
|
CONFIRMED = "CONFIRMED",
|
|
7850
8004
|
PAYMENT_WAITING = "PAYMENT_WAITING",
|
|
@@ -7857,10 +8011,6 @@ interface OrderDetails$3 {
|
|
|
7857
8011
|
*/
|
|
7858
8012
|
checkoutId?: string;
|
|
7859
8013
|
}
|
|
7860
|
-
interface CheckForSpamRequest$1 {
|
|
7861
|
-
/** Form submission. */
|
|
7862
|
-
submission: FormSubmission$3;
|
|
7863
|
-
}
|
|
7864
8014
|
/** Form submission that was created or retrieved. */
|
|
7865
8015
|
interface FormSubmission$3 {
|
|
7866
8016
|
/**
|
|
@@ -7947,6 +8097,10 @@ interface FormSubmissionOrderDetails$1 {
|
|
|
7947
8097
|
*/
|
|
7948
8098
|
checkoutId?: string;
|
|
7949
8099
|
}
|
|
8100
|
+
interface CheckForSpamRequest$1 {
|
|
8101
|
+
/** Form submission. */
|
|
8102
|
+
submission: FormSubmission$3;
|
|
8103
|
+
}
|
|
7950
8104
|
interface CheckForSpamResponse$1 {
|
|
7951
8105
|
/** Is the submission a spam. */
|
|
7952
8106
|
spam?: boolean;
|
|
@@ -8369,7 +8523,7 @@ interface ExtendedFields$2 {
|
|
|
8369
8523
|
namespaces?: Record<string, Record<string, any>>;
|
|
8370
8524
|
}
|
|
8371
8525
|
declare enum SubmissionStatus$2 {
|
|
8372
|
-
|
|
8526
|
+
UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
|
|
8373
8527
|
PENDING = "PENDING",
|
|
8374
8528
|
CONFIRMED = "CONFIRMED",
|
|
8375
8529
|
PAYMENT_WAITING = "PAYMENT_WAITING",
|
|
@@ -8382,10 +8536,6 @@ interface OrderDetails$2 {
|
|
|
8382
8536
|
*/
|
|
8383
8537
|
checkoutId?: string;
|
|
8384
8538
|
}
|
|
8385
|
-
interface CheckForSpamRequest {
|
|
8386
|
-
/** Form submission. */
|
|
8387
|
-
submission: FormSubmission$2;
|
|
8388
|
-
}
|
|
8389
8539
|
/** Form submission that was created or retrieved. */
|
|
8390
8540
|
interface FormSubmission$2 {
|
|
8391
8541
|
/**
|
|
@@ -8472,6 +8622,10 @@ interface FormSubmissionOrderDetails {
|
|
|
8472
8622
|
*/
|
|
8473
8623
|
checkoutId?: string;
|
|
8474
8624
|
}
|
|
8625
|
+
interface CheckForSpamRequest {
|
|
8626
|
+
/** Form submission. */
|
|
8627
|
+
submission: FormSubmission$2;
|
|
8628
|
+
}
|
|
8475
8629
|
interface CheckForSpamResponse {
|
|
8476
8630
|
/** Is the submission a spam. */
|
|
8477
8631
|
spam?: boolean;
|
|
@@ -8903,7 +9057,7 @@ interface FormSubmission$1 {
|
|
|
8903
9057
|
contactId?: string | null;
|
|
8904
9058
|
}
|
|
8905
9059
|
declare enum SubmissionStatus$1 {
|
|
8906
|
-
|
|
9060
|
+
UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
|
|
8907
9061
|
PENDING = "PENDING",
|
|
8908
9062
|
CONFIRMED = "CONFIRMED",
|
|
8909
9063
|
PAYMENT_WAITING = "PAYMENT_WAITING",
|
|
@@ -9573,7 +9727,7 @@ interface FormSubmission {
|
|
|
9573
9727
|
contactId?: string | null;
|
|
9574
9728
|
}
|
|
9575
9729
|
declare enum SubmissionStatus {
|
|
9576
|
-
|
|
9730
|
+
UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
|
|
9577
9731
|
PENDING = "PENDING",
|
|
9578
9732
|
CONFIRMED = "CONFIRMED",
|
|
9579
9733
|
PAYMENT_WAITING = "PAYMENT_WAITING",
|
|
@@ -1,3 +1,40 @@
|
|
|
1
|
+
interface SubmissionContactMapped {
|
|
2
|
+
/**
|
|
3
|
+
* Mapped upserted contact ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
contactId?: string;
|
|
7
|
+
/** Identifies the namespace that the submission's form belongs to. */
|
|
8
|
+
namespace?: string;
|
|
9
|
+
/** Marketing subscription details */
|
|
10
|
+
marketingSubscriptionDetails?: MarketingSubscriptionDetails;
|
|
11
|
+
}
|
|
12
|
+
interface MarketingSubscriptionDetails {
|
|
13
|
+
/** Form id which was submitted */
|
|
14
|
+
formId?: string;
|
|
15
|
+
/** Mapped contact emails. */
|
|
16
|
+
emails?: string[];
|
|
17
|
+
/**
|
|
18
|
+
* Date and time the form submission was created.
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
submittedDate?: Date;
|
|
22
|
+
/**
|
|
23
|
+
* Subscription consent opt in level, either single or double confirmation.
|
|
24
|
+
* Default: SINGLE_CONFIRMATION
|
|
25
|
+
*/
|
|
26
|
+
optInLevel?: OptInLevel;
|
|
27
|
+
}
|
|
28
|
+
declare enum OptInLevel {
|
|
29
|
+
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
30
|
+
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
31
|
+
}
|
|
32
|
+
interface SubmissionContactMappingSkipped {
|
|
33
|
+
/** Form Id. */
|
|
34
|
+
formId?: string;
|
|
35
|
+
/** Identifies the namespace that the submission's form belongs to. */
|
|
36
|
+
namespace?: string;
|
|
37
|
+
}
|
|
1
38
|
interface ValidateSubmissionRequest extends ValidateSubmissionRequestActionsOneOf {
|
|
2
39
|
/** Data for updating an existing submission. */
|
|
3
40
|
updateOptions?: UpdateOptions;
|
|
@@ -446,10 +483,15 @@ type context_IdentificationData = IdentificationData;
|
|
|
446
483
|
type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
447
484
|
type context_IdentityType = IdentityType;
|
|
448
485
|
declare const context_IdentityType: typeof IdentityType;
|
|
486
|
+
type context_MarketingSubscriptionDetails = MarketingSubscriptionDetails;
|
|
449
487
|
type context_MessageEnvelope = MessageEnvelope;
|
|
488
|
+
type context_OptInLevel = OptInLevel;
|
|
489
|
+
declare const context_OptInLevel: typeof OptInLevel;
|
|
450
490
|
type context_OrderDetails = OrderDetails;
|
|
451
491
|
type context_RestoreInfo = RestoreInfo;
|
|
452
492
|
type context_SpiBaseUri = SpiBaseUri;
|
|
493
|
+
type context_SubmissionContactMapped = SubmissionContactMapped;
|
|
494
|
+
type context_SubmissionContactMappingSkipped = SubmissionContactMappingSkipped;
|
|
453
495
|
type context_SubmissionErrorType = SubmissionErrorType;
|
|
454
496
|
declare const context_SubmissionErrorType: typeof SubmissionErrorType;
|
|
455
497
|
type context_SubmissionStatus = SubmissionStatus;
|
|
@@ -466,7 +508,7 @@ type context_WebhookIdentityType = WebhookIdentityType;
|
|
|
466
508
|
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
|
467
509
|
declare const context_provideHandlers: typeof provideHandlers;
|
|
468
510
|
declare namespace context {
|
|
469
|
-
export { type context_ActionEvent as ActionEvent, context_ActionType as ActionType, type context_AlternativeUri as AlternativeUri, type context_Context as Context, type context_ContextIdentificationData as ContextIdentificationData, type context_ContextIdentificationDataIdOneOf as ContextIdentificationDataIdOneOf, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_ExtendedFields as ExtendedFields, type context_FormSubmission as FormSubmission, type context_FormSubmissionSpiExtensionConfig as FormSubmissionSpiExtensionConfig, type context_FormsSubmissionsExtensionNamespaceConfig as FormsSubmissionsExtensionNamespaceConfig, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_MessageEnvelope as MessageEnvelope, type context_OrderDetails as OrderDetails, type context_RestoreInfo as RestoreInfo, type context_SpiBaseUri as SpiBaseUri, context_SubmissionErrorType as SubmissionErrorType, context_SubmissionStatus as SubmissionStatus, type context_SubmissionValidationError as SubmissionValidationError, type context_SubmissionValidationErrorErrorMessageOneOf as SubmissionValidationErrorErrorMessageOneOf, type context_Submitter as Submitter, type context_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, type context_UpdateOptions as UpdateOptions, type context_ValidateSubmissionRequest as ValidateSubmissionRequest, type context_ValidateSubmissionRequestActionsOneOf as ValidateSubmissionRequestActionsOneOf, type context_ValidateSubmissionResponse as ValidateSubmissionResponse, context_WebhookIdentityType as WebhookIdentityType, context_provideHandlers as provideHandlers };
|
|
511
|
+
export { type context_ActionEvent as ActionEvent, context_ActionType as ActionType, type context_AlternativeUri as AlternativeUri, type context_Context as Context, type context_ContextIdentificationData as ContextIdentificationData, type context_ContextIdentificationDataIdOneOf as ContextIdentificationDataIdOneOf, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_ExtendedFields as ExtendedFields, type context_FormSubmission as FormSubmission, type context_FormSubmissionSpiExtensionConfig as FormSubmissionSpiExtensionConfig, type context_FormsSubmissionsExtensionNamespaceConfig as FormsSubmissionsExtensionNamespaceConfig, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_MarketingSubscriptionDetails as MarketingSubscriptionDetails, type context_MessageEnvelope as MessageEnvelope, context_OptInLevel as OptInLevel, type context_OrderDetails as OrderDetails, type context_RestoreInfo as RestoreInfo, type context_SpiBaseUri as SpiBaseUri, type context_SubmissionContactMapped as SubmissionContactMapped, type context_SubmissionContactMappingSkipped as SubmissionContactMappingSkipped, context_SubmissionErrorType as SubmissionErrorType, context_SubmissionStatus as SubmissionStatus, type context_SubmissionValidationError as SubmissionValidationError, type context_SubmissionValidationErrorErrorMessageOneOf as SubmissionValidationErrorErrorMessageOneOf, type context_Submitter as Submitter, type context_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, type context_UpdateOptions as UpdateOptions, type context_ValidateSubmissionRequest as ValidateSubmissionRequest, type context_ValidateSubmissionRequestActionsOneOf as ValidateSubmissionRequestActionsOneOf, type context_ValidateSubmissionResponse as ValidateSubmissionResponse, context_WebhookIdentityType as WebhookIdentityType, context_provideHandlers as provideHandlers };
|
|
470
512
|
}
|
|
471
513
|
|
|
472
514
|
export { context as formSubmissions };
|
|
@@ -1,3 +1,40 @@
|
|
|
1
|
+
interface SubmissionContactMapped {
|
|
2
|
+
/**
|
|
3
|
+
* Mapped upserted contact ID.
|
|
4
|
+
* @readonly
|
|
5
|
+
*/
|
|
6
|
+
contactId?: string;
|
|
7
|
+
/** Identifies the namespace that the submission's form belongs to. */
|
|
8
|
+
namespace?: string;
|
|
9
|
+
/** Marketing subscription details */
|
|
10
|
+
marketingSubscriptionDetails?: MarketingSubscriptionDetails;
|
|
11
|
+
}
|
|
12
|
+
interface MarketingSubscriptionDetails {
|
|
13
|
+
/** Form id which was submitted */
|
|
14
|
+
formId?: string;
|
|
15
|
+
/** Mapped contact emails. */
|
|
16
|
+
emails?: string[];
|
|
17
|
+
/**
|
|
18
|
+
* Date and time the form submission was created.
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
submittedDate?: Date;
|
|
22
|
+
/**
|
|
23
|
+
* Subscription consent opt in level, either single or double confirmation.
|
|
24
|
+
* Default: SINGLE_CONFIRMATION
|
|
25
|
+
*/
|
|
26
|
+
optInLevel?: OptInLevel;
|
|
27
|
+
}
|
|
28
|
+
declare enum OptInLevel {
|
|
29
|
+
SINGLE_CONFIRMATION = "SINGLE_CONFIRMATION",
|
|
30
|
+
DOUBLE_CONFIRMATION = "DOUBLE_CONFIRMATION"
|
|
31
|
+
}
|
|
32
|
+
interface SubmissionContactMappingSkipped {
|
|
33
|
+
/** Form Id. */
|
|
34
|
+
formId?: string;
|
|
35
|
+
/** Identifies the namespace that the submission's form belongs to. */
|
|
36
|
+
namespace?: string;
|
|
37
|
+
}
|
|
1
38
|
interface ValidateSubmissionRequest extends ValidateSubmissionRequestActionsOneOf {
|
|
2
39
|
/** Data for updating an existing submission. */
|
|
3
40
|
updateOptions?: UpdateOptions;
|
|
@@ -449,10 +486,15 @@ type index_d_IdentificationData = IdentificationData;
|
|
|
449
486
|
type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
450
487
|
type index_d_IdentityType = IdentityType;
|
|
451
488
|
declare const index_d_IdentityType: typeof IdentityType;
|
|
489
|
+
type index_d_MarketingSubscriptionDetails = MarketingSubscriptionDetails;
|
|
452
490
|
type index_d_MessageEnvelope = MessageEnvelope;
|
|
491
|
+
type index_d_OptInLevel = OptInLevel;
|
|
492
|
+
declare const index_d_OptInLevel: typeof OptInLevel;
|
|
453
493
|
type index_d_OrderDetails = OrderDetails;
|
|
454
494
|
type index_d_RestoreInfo = RestoreInfo;
|
|
455
495
|
type index_d_SpiBaseUri = SpiBaseUri;
|
|
496
|
+
type index_d_SubmissionContactMapped = SubmissionContactMapped;
|
|
497
|
+
type index_d_SubmissionContactMappingSkipped = SubmissionContactMappingSkipped;
|
|
456
498
|
type index_d_SubmissionErrorType = SubmissionErrorType;
|
|
457
499
|
declare const index_d_SubmissionErrorType: typeof SubmissionErrorType;
|
|
458
500
|
type index_d_SubmissionStatus = SubmissionStatus;
|
|
@@ -470,7 +512,7 @@ type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
|
470
512
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
471
513
|
declare const index_d_provideHandlers: typeof provideHandlers;
|
|
472
514
|
declare namespace index_d {
|
|
473
|
-
export { type index_d_ActionEvent as ActionEvent, index_d_ActionType as ActionType, type index_d_AlternativeUri as AlternativeUri, type index_d_Context as Context, type index_d_ContextIdentificationData as ContextIdentificationData, type index_d_ContextIdentificationDataIdOneOf as ContextIdentificationDataIdOneOf, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_ExtendedFields as ExtendedFields, type index_d_FormSubmission as FormSubmission, type index_d_FormSubmissionSpiExtensionConfig as FormSubmissionSpiExtensionConfig, type index_d_FormsSubmissionsExtensionNamespaceConfig as FormsSubmissionsExtensionNamespaceConfig, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_MessageEnvelope as MessageEnvelope, type index_d_OrderDetails as OrderDetails, type index_d_RestoreInfo as RestoreInfo, type index_d_SpiBaseUri as SpiBaseUri, index_d_SubmissionErrorType as SubmissionErrorType, index_d_SubmissionStatus as SubmissionStatus, type index_d_SubmissionValidationError as SubmissionValidationError, type index_d_SubmissionValidationErrorErrorMessageOneOf as SubmissionValidationErrorErrorMessageOneOf, type index_d_Submitter as Submitter, type index_d_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, type index_d_UpdateOptions as UpdateOptions, type index_d_ValidateSubmissionEnvelope as ValidateSubmissionEnvelope, type index_d_ValidateSubmissionRequest as ValidateSubmissionRequest, type index_d_ValidateSubmissionRequestActionsOneOf as ValidateSubmissionRequestActionsOneOf, type index_d_ValidateSubmissionResponse as ValidateSubmissionResponse, index_d_WebhookIdentityType as WebhookIdentityType, index_d_provideHandlers as provideHandlers };
|
|
515
|
+
export { type index_d_ActionEvent as ActionEvent, index_d_ActionType as ActionType, type index_d_AlternativeUri as AlternativeUri, type index_d_Context as Context, type index_d_ContextIdentificationData as ContextIdentificationData, type index_d_ContextIdentificationDataIdOneOf as ContextIdentificationDataIdOneOf, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_ExtendedFields as ExtendedFields, type index_d_FormSubmission as FormSubmission, type index_d_FormSubmissionSpiExtensionConfig as FormSubmissionSpiExtensionConfig, type index_d_FormsSubmissionsExtensionNamespaceConfig as FormsSubmissionsExtensionNamespaceConfig, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_MarketingSubscriptionDetails as MarketingSubscriptionDetails, type index_d_MessageEnvelope as MessageEnvelope, index_d_OptInLevel as OptInLevel, type index_d_OrderDetails as OrderDetails, type index_d_RestoreInfo as RestoreInfo, type index_d_SpiBaseUri as SpiBaseUri, type index_d_SubmissionContactMapped as SubmissionContactMapped, type index_d_SubmissionContactMappingSkipped as SubmissionContactMappingSkipped, index_d_SubmissionErrorType as SubmissionErrorType, index_d_SubmissionStatus as SubmissionStatus, type index_d_SubmissionValidationError as SubmissionValidationError, type index_d_SubmissionValidationErrorErrorMessageOneOf as SubmissionValidationErrorErrorMessageOneOf, type index_d_Submitter as Submitter, type index_d_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf, type index_d_UpdateOptions as UpdateOptions, type index_d_ValidateSubmissionEnvelope as ValidateSubmissionEnvelope, type index_d_ValidateSubmissionRequest as ValidateSubmissionRequest, type index_d_ValidateSubmissionRequestActionsOneOf as ValidateSubmissionRequestActionsOneOf, type index_d_ValidateSubmissionResponse as ValidateSubmissionResponse, index_d_WebhookIdentityType as WebhookIdentityType, index_d_provideHandlers as provideHandlers };
|
|
474
516
|
}
|
|
475
517
|
|
|
476
518
|
export { index_d as formSubmissions };
|