@wix/forms 1.0.170 → 1.0.172

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.
@@ -81,6 +81,7 @@ interface Form$1 {
81
81
  sourceFormId?: string | null;
82
82
  }
83
83
  declare enum RequiredIndicator$1 {
84
+ /** Unknown required indicator. */
84
85
  UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
85
86
  /** Asterisk (*). */
86
87
  ASTERISK = "ASTERISK",
@@ -90,6 +91,7 @@ declare enum RequiredIndicator$1 {
90
91
  NONE = "NONE"
91
92
  }
92
93
  declare enum RequiredIndicatorPlacement$1 {
94
+ /** Unknown required indicator placement. */
93
95
  UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
94
96
  /** After field title. */
95
97
  AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
@@ -341,13 +343,15 @@ interface PaymentType$1 {
341
343
  maxItems?: number | null;
342
344
  }
343
345
  declare enum ProductType$1 {
346
+ /** Unknown product type. */
344
347
  UNKNOWN = "UNKNOWN",
345
- /** Shippable (physical). */
348
+ /** Shippable (physical) product. */
346
349
  SHIPPABLE = "SHIPPABLE",
347
- /** Digital. */
350
+ /** Digital product. */
348
351
  DIGITAL = "DIGITAL"
349
352
  }
350
353
  declare enum PriceType$1 {
354
+ /** Unknown price type. */
351
355
  UNKNOWN = "UNKNOWN",
352
356
  /** Fixed price. */
353
357
  FIXED_PRICE = "FIXED_PRICE",
@@ -1856,10 +1860,15 @@ interface RadioGroupCustomOption$1 {
1856
1860
  placeholder?: string | null;
1857
1861
  }
1858
1862
  declare enum NumberOfColumns$1 {
1863
+ /** Undefined number of columns. */
1859
1864
  UNKNOWN = "UNKNOWN",
1865
+ /** Zero columns. */
1860
1866
  ZERO = "ZERO",
1867
+ /** One column. */
1861
1868
  ONE = "ONE",
1869
+ /** Two columns. */
1862
1870
  TWO = "TWO",
1871
+ /** Three columns. */
1863
1872
  THREE = "THREE"
1864
1873
  }
1865
1874
  interface Dropdown$1 {
@@ -1989,7 +1998,9 @@ interface DatePicker$1 {
1989
1998
  firstDayOfWeek?: FirstDayOfWeek$1;
1990
1999
  }
1991
2000
  declare enum FirstDayOfWeek$1 {
2001
+ /** First day of the week is Monday. */
1992
2002
  MONDAY = "MONDAY",
2003
+ /** First day of the week is Sunday. */
1993
2004
  SUNDAY = "SUNDAY"
1994
2005
  }
1995
2006
  interface InputFieldNumberType$1 {
@@ -2314,16 +2325,17 @@ interface FileUpload$1 {
2314
2325
  explanationText?: string | null;
2315
2326
  }
2316
2327
  declare enum UploadFileFormat$1 {
2328
+ /** Undefined upload file format. */
2317
2329
  UNDEFINED = "UNDEFINED",
2318
- /** Video files */
2330
+ /** Video files. */
2319
2331
  VIDEO = "VIDEO",
2320
- /** Image files */
2332
+ /** Image files. */
2321
2333
  IMAGE = "IMAGE",
2322
- /** Audio files */
2334
+ /** Audio files. */
2323
2335
  AUDIO = "AUDIO",
2324
- /** Document files */
2336
+ /** Document files. */
2325
2337
  DOCUMENT = "DOCUMENT",
2326
- /** Archive files */
2338
+ /** Archive files. */
2327
2339
  ARCHIVE = "ARCHIVE"
2328
2340
  }
2329
2341
  interface Signature$1 {
@@ -2450,8 +2462,9 @@ interface MultilineAddress$1 {
2450
2462
  autocompleteEnabled?: boolean;
2451
2463
  }
2452
2464
  declare enum Type$1 {
2465
+ /** Unknown default country config type. */
2453
2466
  UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
2454
- /** Country will be determined by customer's IP address. */
2467
+ /** Country is determined by customer's IP address. */
2455
2468
  BY_IP = "BY_IP",
2456
2469
  /** Pre-selected default country. */
2457
2470
  COUNTRY = "COUNTRY"
@@ -2747,10 +2760,11 @@ interface RichText$1 {
2747
2760
  content?: RichContent$1;
2748
2761
  }
2749
2762
  declare enum Target$1 {
2763
+ /** Undefined target. */
2750
2764
  UNDEFINED = "UNDEFINED",
2751
- /** Opened in same browser tab */
2765
+ /** Open in the same browser tab. */
2752
2766
  SELF = "SELF",
2753
- /** Url open in new tab */
2767
+ /** Open in a new tab. */
2754
2768
  BLANK = "BLANK"
2755
2769
  }
2756
2770
  interface ThankYouMessage$1 {
@@ -2998,7 +3012,9 @@ interface FormProperties$1 {
2998
3012
  disabled?: boolean;
2999
3013
  }
3000
3014
  declare enum Kind$1 {
3015
+ /** Return forms specific to tenant, excluding template based forms. */
3001
3016
  REGULAR = "REGULAR",
3017
+ /** Return forms based on common templates, with applied user overrides if they exist. */
3002
3018
  EXTENSION = "EXTENSION"
3003
3019
  }
3004
3020
  interface PostSubmissionTriggers$1 {
@@ -3033,6 +3049,7 @@ interface LimitationRule$1 {
3033
3049
  dateTimeDeadline?: Date | null;
3034
3050
  }
3035
3051
  declare enum SpamFilterProtectionLevel$1 {
3052
+ /** Unknown spam filter protection level. */
3036
3053
  UNKNOWN = "UNKNOWN",
3037
3054
  /** Spam filter is not used. Form is open for spam submissions. */
3038
3055
  NONE = "NONE",
@@ -3063,6 +3080,7 @@ interface SubmitSettingsSubmitSuccessActionOptionsOneOf$1 {
3063
3080
  redirectOptions?: RedirectOptions$1;
3064
3081
  }
3065
3082
  declare enum UrlTargetEnumTarget$1 {
3083
+ /** Unknown target. */
3066
3084
  UNKNOWN_TARGET = "UNKNOWN_TARGET",
3067
3085
  /** Open in the same browser tab. */
3068
3086
  SELF = "SELF",
@@ -3070,6 +3088,7 @@ declare enum UrlTargetEnumTarget$1 {
3070
3088
  BLANK = "BLANK"
3071
3089
  }
3072
3090
  declare enum SubmitSuccessAction$1 {
3091
+ /** Unknown submit success action. */
3073
3092
  UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
3074
3093
  /** No action will be taken after submission. */
3075
3094
  NO_ACTION = "NO_ACTION",
@@ -3424,7 +3443,7 @@ interface BulkRemoveDeletedFieldResponse$1 {
3424
3443
  /** Form with the deleted fields. */
3425
3444
  form?: Form$1;
3426
3445
  }
3427
- interface UpdateExtendedFieldsRequest$1 {
3446
+ interface UpdateExtendedFieldsRequest$3 {
3428
3447
  /** ID of the entity to update. */
3429
3448
  id: string;
3430
3449
  /** Identifier for the app whose extended fields are being updated. */
@@ -3432,7 +3451,7 @@ interface UpdateExtendedFieldsRequest$1 {
3432
3451
  /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
3433
3452
  namespaceData: Record<string, any> | null;
3434
3453
  }
3435
- interface UpdateExtendedFieldsResponse$1 {
3454
+ interface UpdateExtendedFieldsResponse$3 {
3436
3455
  /** namespace that was updated */
3437
3456
  namespace?: string;
3438
3457
  /** only data from UpdateExtendedFieldsRequest namespace_data */
@@ -4177,7 +4196,7 @@ interface ListDeletedFormsResponseNonNullableFields$1 {
4177
4196
  interface BulkRemoveDeletedFieldResponseNonNullableFields$1 {
4178
4197
  form?: FormNonNullableFields$1;
4179
4198
  }
4180
- interface UpdateExtendedFieldsResponseNonNullableFields$1 {
4199
+ interface UpdateExtendedFieldsResponseNonNullableFields$3 {
4181
4200
  namespace: string;
4182
4201
  }
4183
4202
  interface FormProviderRestrictionsNonNullableFields$1 {
@@ -4276,6 +4295,7 @@ interface Form {
4276
4295
  sourceFormId?: string | null;
4277
4296
  }
4278
4297
  declare enum RequiredIndicator {
4298
+ /** Unknown required indicator. */
4279
4299
  UNKNOWN_INDICATOR = "UNKNOWN_INDICATOR",
4280
4300
  /** Asterisk (*). */
4281
4301
  ASTERISK = "ASTERISK",
@@ -4285,6 +4305,7 @@ declare enum RequiredIndicator {
4285
4305
  NONE = "NONE"
4286
4306
  }
4287
4307
  declare enum RequiredIndicatorPlacement {
4308
+ /** Unknown required indicator placement. */
4288
4309
  UNKNOWN_PLACEMENT = "UNKNOWN_PLACEMENT",
4289
4310
  /** After field title. */
4290
4311
  AFTER_FIELD_TITLE = "AFTER_FIELD_TITLE",
@@ -4536,13 +4557,15 @@ interface PaymentType {
4536
4557
  maxItems?: number | null;
4537
4558
  }
4538
4559
  declare enum ProductType {
4560
+ /** Unknown product type. */
4539
4561
  UNKNOWN = "UNKNOWN",
4540
- /** Shippable (physical). */
4562
+ /** Shippable (physical) product. */
4541
4563
  SHIPPABLE = "SHIPPABLE",
4542
- /** Digital. */
4564
+ /** Digital product. */
4543
4565
  DIGITAL = "DIGITAL"
4544
4566
  }
4545
4567
  declare enum PriceType {
4568
+ /** Unknown price type. */
4546
4569
  UNKNOWN = "UNKNOWN",
4547
4570
  /** Fixed price. */
4548
4571
  FIXED_PRICE = "FIXED_PRICE",
@@ -6051,10 +6074,15 @@ interface RadioGroupCustomOption {
6051
6074
  placeholder?: string | null;
6052
6075
  }
6053
6076
  declare enum NumberOfColumns {
6077
+ /** Undefined number of columns. */
6054
6078
  UNKNOWN = "UNKNOWN",
6079
+ /** Zero columns. */
6055
6080
  ZERO = "ZERO",
6081
+ /** One column. */
6056
6082
  ONE = "ONE",
6083
+ /** Two columns. */
6057
6084
  TWO = "TWO",
6085
+ /** Three columns. */
6058
6086
  THREE = "THREE"
6059
6087
  }
6060
6088
  interface Dropdown {
@@ -6184,7 +6212,9 @@ interface DatePicker {
6184
6212
  firstDayOfWeek?: FirstDayOfWeek;
6185
6213
  }
6186
6214
  declare enum FirstDayOfWeek {
6215
+ /** First day of the week is Monday. */
6187
6216
  MONDAY = "MONDAY",
6217
+ /** First day of the week is Sunday. */
6188
6218
  SUNDAY = "SUNDAY"
6189
6219
  }
6190
6220
  interface InputFieldNumberType {
@@ -6486,16 +6516,17 @@ interface FileUpload {
6486
6516
  explanationText?: string | null;
6487
6517
  }
6488
6518
  declare enum UploadFileFormat {
6519
+ /** Undefined upload file format. */
6489
6520
  UNDEFINED = "UNDEFINED",
6490
- /** Video files */
6521
+ /** Video files. */
6491
6522
  VIDEO = "VIDEO",
6492
- /** Image files */
6523
+ /** Image files. */
6493
6524
  IMAGE = "IMAGE",
6494
- /** Audio files */
6525
+ /** Audio files. */
6495
6526
  AUDIO = "AUDIO",
6496
- /** Document files */
6527
+ /** Document files. */
6497
6528
  DOCUMENT = "DOCUMENT",
6498
- /** Archive files */
6529
+ /** Archive files. */
6499
6530
  ARCHIVE = "ARCHIVE"
6500
6531
  }
6501
6532
  interface Signature {
@@ -6622,8 +6653,9 @@ interface MultilineAddress {
6622
6653
  autocompleteEnabled?: boolean;
6623
6654
  }
6624
6655
  declare enum Type {
6656
+ /** Unknown default country config type. */
6625
6657
  UNKNOWN_DEFAULT_COUNTRY = "UNKNOWN_DEFAULT_COUNTRY",
6626
- /** Country will be determined by customer's IP address. */
6658
+ /** Country is determined by customer's IP address. */
6627
6659
  BY_IP = "BY_IP",
6628
6660
  /** Pre-selected default country. */
6629
6661
  COUNTRY = "COUNTRY"
@@ -6919,10 +6951,11 @@ interface RichText {
6919
6951
  content?: RichContent;
6920
6952
  }
6921
6953
  declare enum Target {
6954
+ /** Undefined target. */
6922
6955
  UNDEFINED = "UNDEFINED",
6923
- /** Opened in same browser tab */
6956
+ /** Open in the same browser tab. */
6924
6957
  SELF = "SELF",
6925
- /** Url open in new tab */
6958
+ /** Open in a new tab. */
6926
6959
  BLANK = "BLANK"
6927
6960
  }
6928
6961
  interface ThankYouMessage {
@@ -7170,7 +7203,9 @@ interface FormProperties {
7170
7203
  disabled?: boolean;
7171
7204
  }
7172
7205
  declare enum Kind {
7206
+ /** Return forms specific to tenant, excluding template based forms. */
7173
7207
  REGULAR = "REGULAR",
7208
+ /** Return forms based on common templates, with applied user overrides if they exist. */
7174
7209
  EXTENSION = "EXTENSION"
7175
7210
  }
7176
7211
  interface PostSubmissionTriggers {
@@ -7205,6 +7240,7 @@ interface LimitationRule {
7205
7240
  dateTimeDeadline?: Date | null;
7206
7241
  }
7207
7242
  declare enum SpamFilterProtectionLevel {
7243
+ /** Unknown spam filter protection level. */
7208
7244
  UNKNOWN = "UNKNOWN",
7209
7245
  /** Spam filter is not used. Form is open for spam submissions. */
7210
7246
  NONE = "NONE",
@@ -7235,6 +7271,7 @@ interface SubmitSettingsSubmitSuccessActionOptionsOneOf {
7235
7271
  redirectOptions?: RedirectOptions;
7236
7272
  }
7237
7273
  declare enum UrlTargetEnumTarget {
7274
+ /** Unknown target. */
7238
7275
  UNKNOWN_TARGET = "UNKNOWN_TARGET",
7239
7276
  /** Open in the same browser tab. */
7240
7277
  SELF = "SELF",
@@ -7242,6 +7279,7 @@ declare enum UrlTargetEnumTarget {
7242
7279
  BLANK = "BLANK"
7243
7280
  }
7244
7281
  declare enum SubmitSuccessAction {
7282
+ /** Unknown submit success action. */
7245
7283
  UNKNOWN_SUBMIT_SUCCESS_ACTION = "UNKNOWN_SUBMIT_SUCCESS_ACTION",
7246
7284
  /** No action will be taken after submission. */
7247
7285
  NO_ACTION = "NO_ACTION",
@@ -7596,7 +7634,7 @@ interface BulkRemoveDeletedFieldResponse {
7596
7634
  /** Form with the deleted fields. */
7597
7635
  form?: Form;
7598
7636
  }
7599
- interface UpdateExtendedFieldsRequest {
7637
+ interface UpdateExtendedFieldsRequest$2 {
7600
7638
  /** ID of the entity to update. */
7601
7639
  _id: string;
7602
7640
  /** Identifier for the app whose extended fields are being updated. */
@@ -7604,7 +7642,7 @@ interface UpdateExtendedFieldsRequest {
7604
7642
  /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
7605
7643
  namespaceData: Record<string, any> | null;
7606
7644
  }
7607
- interface UpdateExtendedFieldsResponse {
7645
+ interface UpdateExtendedFieldsResponse$2 {
7608
7646
  /** namespace that was updated */
7609
7647
  namespace?: string;
7610
7648
  /** only data from UpdateExtendedFieldsRequest namespace_data */
@@ -8343,7 +8381,7 @@ interface ListDeletedFormsResponseNonNullableFields {
8343
8381
  interface BulkRemoveDeletedFieldResponseNonNullableFields {
8344
8382
  form?: FormNonNullableFields;
8345
8383
  }
8346
- interface UpdateExtendedFieldsResponseNonNullableFields {
8384
+ interface UpdateExtendedFieldsResponseNonNullableFields$2 {
8347
8385
  namespace: string;
8348
8386
  }
8349
8387
  interface FormProviderRestrictionsNonNullableFields {
@@ -8398,9 +8436,9 @@ declare function getDeletedForm(): __PublicMethodMetaInfo$2<'GET', {
8398
8436
  declare function queryDeletedForms(): __PublicMethodMetaInfo$2<'POST', {}, QueryDeletedFormsRequest, QueryDeletedFormsRequest$1, QueryDeletedFormsResponse & QueryDeletedFormsResponseNonNullableFields, QueryDeletedFormsResponse$1 & QueryDeletedFormsResponseNonNullableFields$1>;
8399
8437
  declare function listDeletedForms(): __PublicMethodMetaInfo$2<'GET', {}, ListDeletedFormsRequest, ListDeletedFormsRequest$1, ListDeletedFormsResponse & ListDeletedFormsResponseNonNullableFields, ListDeletedFormsResponse$1 & ListDeletedFormsResponseNonNullableFields$1>;
8400
8438
  declare function bulkRemoveDeletedField(): __PublicMethodMetaInfo$2<'POST', {}, BulkRemoveDeletedFieldRequest, BulkRemoveDeletedFieldRequest$1, BulkRemoveDeletedFieldResponse & BulkRemoveDeletedFieldResponseNonNullableFields, BulkRemoveDeletedFieldResponse$1 & BulkRemoveDeletedFieldResponseNonNullableFields$1>;
8401
- declare function updateExtendedFields(): __PublicMethodMetaInfo$2<'POST', {
8439
+ declare function updateExtendedFields$1(): __PublicMethodMetaInfo$2<'POST', {
8402
8440
  id: string;
8403
- }, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
8441
+ }, UpdateExtendedFieldsRequest$2, UpdateExtendedFieldsRequest$3, UpdateExtendedFieldsResponse$2 & UpdateExtendedFieldsResponseNonNullableFields$2, UpdateExtendedFieldsResponse$3 & UpdateExtendedFieldsResponseNonNullableFields$3>;
8404
8442
  declare function listFormsProvidersConfigs(): __PublicMethodMetaInfo$2<'GET', {}, ListFormsProvidersConfigsRequest, ListFormsProvidersConfigsRequest$1, ListFormsProvidersConfigsResponse & ListFormsProvidersConfigsResponseNonNullableFields, ListFormsProvidersConfigsResponse$1 & ListFormsProvidersConfigsResponseNonNullableFields$1>;
8405
8443
 
8406
8444
  declare const meta$2_bulkCreateForm: typeof bulkCreateForm;
@@ -8418,10 +8456,9 @@ declare const meta$2_queryDeletedForms: typeof queryDeletedForms;
8418
8456
  declare const meta$2_queryForms: typeof queryForms;
8419
8457
  declare const meta$2_removeFormFromTrashBin: typeof removeFormFromTrashBin;
8420
8458
  declare const meta$2_restoreFromTrashBin: typeof restoreFromTrashBin;
8421
- declare const meta$2_updateExtendedFields: typeof updateExtendedFields;
8422
8459
  declare const meta$2_updateForm: typeof updateForm;
8423
8460
  declare namespace meta$2 {
8424
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkCreateForm as bulkCreateForm, meta$2_bulkRemoveDeletedField as bulkRemoveDeletedField, meta$2_cloneForm as cloneForm, meta$2_countForms as countForms, meta$2_createForm as createForm, meta$2_deleteForm as deleteForm, meta$2_getDeletedForm as getDeletedForm, meta$2_getForm as getForm, meta$2_listDeletedForms as listDeletedForms, meta$2_listForms as listForms, meta$2_listFormsProvidersConfigs as listFormsProvidersConfigs, meta$2_queryDeletedForms as queryDeletedForms, meta$2_queryForms as queryForms, meta$2_removeFormFromTrashBin as removeFormFromTrashBin, meta$2_restoreFromTrashBin as restoreFromTrashBin, meta$2_updateExtendedFields as updateExtendedFields, meta$2_updateForm as updateForm };
8461
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_bulkCreateForm as bulkCreateForm, meta$2_bulkRemoveDeletedField as bulkRemoveDeletedField, meta$2_cloneForm as cloneForm, meta$2_countForms as countForms, meta$2_createForm as createForm, meta$2_deleteForm as deleteForm, meta$2_getDeletedForm as getDeletedForm, meta$2_getForm as getForm, meta$2_listDeletedForms as listDeletedForms, meta$2_listForms as listForms, meta$2_listFormsProvidersConfigs as listFormsProvidersConfigs, meta$2_queryDeletedForms as queryDeletedForms, meta$2_queryForms as queryForms, meta$2_removeFormFromTrashBin as removeFormFromTrashBin, meta$2_restoreFromTrashBin as restoreFromTrashBin, updateExtendedFields$1 as updateExtendedFields, meta$2_updateForm as updateForm };
8425
8462
  }
8426
8463
 
8427
8464
  /**
@@ -10062,6 +10099,20 @@ interface DocumentReady$1 {
10062
10099
  */
10063
10100
  downloadUrl?: string;
10064
10101
  }
10102
+ interface UpdateExtendedFieldsRequest$1 {
10103
+ /** ID of the entity to update. */
10104
+ id: string;
10105
+ /** Identifier for the app whose extended fields are being updated. */
10106
+ namespace: string;
10107
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
10108
+ namespaceData: Record<string, any> | null;
10109
+ }
10110
+ interface UpdateExtendedFieldsResponse$1 {
10111
+ /** namespace that was updated */
10112
+ namespace?: string;
10113
+ /** only data from UpdateExtendedFieldsRequest namespace_data */
10114
+ namespaceData?: Record<string, any> | null;
10115
+ }
10065
10116
  interface UpsertContactFromSubmissionRequest$1 {
10066
10117
  /** Submission from which contact needs to be upserted. */
10067
10118
  submissionId: string;
@@ -10211,6 +10262,9 @@ interface SubmissionDocumentNonNullableFields$1 {
10211
10262
  interface GetSubmissionDownloadUrlResponseNonNullableFields$1 {
10212
10263
  document?: SubmissionDocumentNonNullableFields$1;
10213
10264
  }
10265
+ interface UpdateExtendedFieldsResponseNonNullableFields$1 {
10266
+ namespace: string;
10267
+ }
10214
10268
  interface SubmitContactResponseNonNullableFields$1 {
10215
10269
  contactId: string;
10216
10270
  identityType: IdentityType$1;
@@ -10777,6 +10831,20 @@ interface DocumentReady {
10777
10831
  */
10778
10832
  downloadUrl?: string;
10779
10833
  }
10834
+ interface UpdateExtendedFieldsRequest {
10835
+ /** ID of the entity to update. */
10836
+ _id: string;
10837
+ /** Identifier for the app whose extended fields are being updated. */
10838
+ namespace: string;
10839
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
10840
+ namespaceData: Record<string, any> | null;
10841
+ }
10842
+ interface UpdateExtendedFieldsResponse {
10843
+ /** namespace that was updated */
10844
+ namespace?: string;
10845
+ /** only data from UpdateExtendedFieldsRequest namespace_data */
10846
+ namespaceData?: Record<string, any> | null;
10847
+ }
10780
10848
  interface UpsertContactFromSubmissionRequest {
10781
10849
  /** Submission from which contact needs to be upserted. */
10782
10850
  submissionId: string;
@@ -10926,6 +10994,9 @@ interface SubmissionDocumentNonNullableFields {
10926
10994
  interface GetSubmissionDownloadUrlResponseNonNullableFields {
10927
10995
  document?: SubmissionDocumentNonNullableFields;
10928
10996
  }
10997
+ interface UpdateExtendedFieldsResponseNonNullableFields {
10998
+ namespace: string;
10999
+ }
10929
11000
  interface SubmitContactResponseNonNullableFields {
10930
11001
  contactId: string;
10931
11002
  identityType: IdentityType;
@@ -10982,6 +11053,9 @@ declare function bulkMarkSubmissionsAsSeen(): __PublicMethodMetaInfo<'POST', {},
10982
11053
  declare function getSubmissionDownloadUrl(): __PublicMethodMetaInfo<'GET', {
10983
11054
  submissionId: string;
10984
11055
  }, GetSubmissionDownloadUrlRequest, GetSubmissionDownloadUrlRequest$1, GetSubmissionDownloadUrlResponse & GetSubmissionDownloadUrlResponseNonNullableFields, GetSubmissionDownloadUrlResponse$1 & GetSubmissionDownloadUrlResponseNonNullableFields$1>;
11056
+ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
11057
+ id: string;
11058
+ }, UpdateExtendedFieldsRequest, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields, UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
10985
11059
  declare function upsertContactFromSubmission(): __PublicMethodMetaInfo<'POST', {}, UpsertContactFromSubmissionRequest, UpsertContactFromSubmissionRequest$1, UpsertContactFromSubmissionResponse & UpsertContactFromSubmissionResponseNonNullableFields, UpsertContactFromSubmissionResponse$1 & UpsertContactFromSubmissionResponseNonNullableFields$1>;
10986
11060
 
10987
11061
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
@@ -11005,10 +11079,11 @@ declare const meta_querySubmissionsByNamespace: typeof querySubmissionsByNamespa
11005
11079
  declare const meta_removeSubmissionFromTrashBin: typeof removeSubmissionFromTrashBin;
11006
11080
  declare const meta_restoreSubmissionFromTrashBin: typeof restoreSubmissionFromTrashBin;
11007
11081
  declare const meta_searchSubmissionsByNamespace: typeof searchSubmissionsByNamespace;
11082
+ declare const meta_updateExtendedFields: typeof updateExtendedFields;
11008
11083
  declare const meta_updateSubmission: typeof updateSubmission;
11009
11084
  declare const meta_upsertContactFromSubmission: typeof upsertContactFromSubmission;
11010
11085
  declare namespace meta {
11011
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCreateSubmissionBySubmitter as bulkCreateSubmissionBySubmitter, meta_bulkDeleteSubmission as bulkDeleteSubmission, meta_bulkMarkSubmissionsAsSeen as bulkMarkSubmissionsAsSeen, meta_bulkRemoveSubmissionFromTrashBin as bulkRemoveSubmissionFromTrashBin, meta_confirmSubmission as confirmSubmission, meta_countDeletedSubmissions as countDeletedSubmissions, meta_countSubmissions as countSubmissions, meta_countSubmissionsByFilter as countSubmissionsByFilter, meta_createSubmission as createSubmission, meta_deleteSubmission as deleteSubmission, meta_getDeletedSubmission as getDeletedSubmission, meta_getMediaUploadUrl as getMediaUploadUrl, meta_getSubmission as getSubmission, meta_getSubmissionDownloadUrl as getSubmissionDownloadUrl, meta_listDeletedSubmissions as listDeletedSubmissions, meta_querySubmission as querySubmission, meta_querySubmissionsByNamespace as querySubmissionsByNamespace, meta_removeSubmissionFromTrashBin as removeSubmissionFromTrashBin, meta_restoreSubmissionFromTrashBin as restoreSubmissionFromTrashBin, meta_searchSubmissionsByNamespace as searchSubmissionsByNamespace, meta_updateSubmission as updateSubmission, meta_upsertContactFromSubmission as upsertContactFromSubmission };
11086
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkCreateSubmissionBySubmitter as bulkCreateSubmissionBySubmitter, meta_bulkDeleteSubmission as bulkDeleteSubmission, meta_bulkMarkSubmissionsAsSeen as bulkMarkSubmissionsAsSeen, meta_bulkRemoveSubmissionFromTrashBin as bulkRemoveSubmissionFromTrashBin, meta_confirmSubmission as confirmSubmission, meta_countDeletedSubmissions as countDeletedSubmissions, meta_countSubmissions as countSubmissions, meta_countSubmissionsByFilter as countSubmissionsByFilter, meta_createSubmission as createSubmission, meta_deleteSubmission as deleteSubmission, meta_getDeletedSubmission as getDeletedSubmission, meta_getMediaUploadUrl as getMediaUploadUrl, meta_getSubmission as getSubmission, meta_getSubmissionDownloadUrl as getSubmissionDownloadUrl, meta_listDeletedSubmissions as listDeletedSubmissions, meta_querySubmission as querySubmission, meta_querySubmissionsByNamespace as querySubmissionsByNamespace, meta_removeSubmissionFromTrashBin as removeSubmissionFromTrashBin, meta_restoreSubmissionFromTrashBin as restoreSubmissionFromTrashBin, meta_searchSubmissionsByNamespace as searchSubmissionsByNamespace, meta_updateExtendedFields as updateExtendedFields, meta_updateSubmission as updateSubmission, meta_upsertContactFromSubmission as upsertContactFromSubmission };
11012
11087
  }
11013
11088
 
11014
11089
  export { meta$1 as formSpamSubmissionReports, meta$2 as forms, meta as submissions };
@@ -25,13 +25,7 @@ interface FormSubmission {
25
25
  * @readonly
26
26
  */
27
27
  namespace?: string;
28
- /**
29
- * Status of the submission.
30
- * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
31
- * - `PAYMENT_WAITING`: A form submission requiring payment is created.
32
- * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
33
- * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
34
- */
28
+ /** Status of the submission. */
35
29
  status?: SubmissionStatus;
36
30
  /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
37
31
  submissions?: Record<string, any>;
@@ -66,9 +60,13 @@ interface FormSubmission {
66
60
  }
67
61
  declare enum SubmissionStatus {
68
62
  UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
63
+ /** A submission is created, but has not yet been recorded in the Wix Forms collection. */
69
64
  PENDING = "PENDING",
65
+ /** A submission is recorded in the Wix Forms collection. */
70
66
  CONFIRMED = "CONFIRMED",
67
+ /** A form submission requiring payment is created. */
71
68
  PAYMENT_WAITING = "PAYMENT_WAITING",
69
+ /** An order of a form submission is canceled. */
72
70
  PAYMENT_CANCELED = "PAYMENT_CANCELED"
73
71
  }
74
72
  interface Submitter extends SubmitterSubmitterOneOf {
@@ -131,8 +129,11 @@ interface OrderDetails {
131
129
  checkoutId?: string;
132
130
  }
133
131
  declare enum ActionType {
132
+ /** Unknown action type. */
134
133
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
134
+ /** Update submission. */
135
135
  UPDATE = "UPDATE",
136
+ /** Create submission. */
136
137
  CREATE = "CREATE"
137
138
  }
138
139
  interface UpdateOptions {
@@ -164,35 +165,35 @@ interface SubmissionValidationErrorErrorMessageOneOf {
164
165
  customErrorMessage?: string;
165
166
  }
166
167
  declare enum SubmissionErrorType {
167
- /** Error is unknown or not suitable for any of options bellow */
168
+ /** Error is unknown or unsuitable for any of the options below. */
168
169
  UNKNOWN_ERROR = "UNKNOWN_ERROR",
169
- /** Type of submitted value is incorrect */
170
+ /** Type of submitted value is incorrect. */
170
171
  TYPE_ERROR = "TYPE_ERROR",
171
- /** Value is required to be provided */
172
+ /** Value is required to be provided. */
172
173
  REQUIRED_VALUE_ERROR = "REQUIRED_VALUE_ERROR",
173
- /** Value contains additional properties not expected in schema */
174
+ /** Value contains additional properties not expected in schema. */
174
175
  UNKNOWN_VALUE_ERROR = "UNKNOWN_VALUE_ERROR",
175
- /** Text value exceeds max length */
176
+ /** Text value exceeds max length. */
176
177
  MAX_LENGTH_ERROR = "MAX_LENGTH_ERROR",
177
- /** Text value not reaches min length */
178
+ /** Text value does not reach min length. */
178
179
  MIN_LENGTH_ERROR = "MIN_LENGTH_ERROR",
179
- /** Text value not applicable for expected pattern */
180
+ /** Text value is not applicable for expected pattern. */
180
181
  PATTERN_ERROR = "PATTERN_ERROR",
181
- /** Text value not applicable for expected format */
182
+ /** Text value is not applicable for expected format. */
182
183
  FORMAT_ERROR = "FORMAT_ERROR",
183
- /** Number value is too big */
184
+ /** Number value is too big. */
184
185
  MAX_VALUE_ERROR = "MAX_VALUE_ERROR",
185
- /** Number value is too small */
186
+ /** Number value is too small. */
186
187
  MIN_VALUE_ERROR = "MIN_VALUE_ERROR",
187
- /** Number value is not multiple of expected number */
188
+ /** Number value is not a multiple of expected number. */
188
189
  MULTIPLE_OF_VALUE_ERROR = "MULTIPLE_OF_VALUE_ERROR",
189
- /** Array value has too much items */
190
+ /** Array value has too many items. */
190
191
  MIN_ITEMS_ERROR = "MIN_ITEMS_ERROR",
191
- /** Array value has not enough items */
192
+ /** Array value has not enough items. */
192
193
  MAX_ITEMS_ERROR = "MAX_ITEMS_ERROR",
193
- /** Value is not in list of allowed values */
194
+ /** Value is not in the list of allowed values. */
194
195
  NOT_ALLOWED_VALUE_ERROR = "NOT_ALLOWED_VALUE_ERROR",
195
- /** Submitted form is disabled */
196
+ /** Submitted form is disabled. */
196
197
  DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
197
198
  }
198
199
  interface FormSubmissionSpiExtensionConfig {
@@ -25,13 +25,7 @@ interface FormSubmission {
25
25
  * @readonly
26
26
  */
27
27
  namespace?: string;
28
- /**
29
- * Status of the submission.
30
- * - `PENDING`: A submission is created, but has not yet been recorded in the Wix Forms collection.
31
- * - `PAYMENT_WAITING`: A form submission requiring payment is created.
32
- * - `PAYMENT_CANCELED`: An order of a form submission is canceled.
33
- * - `CONFIRMED`: A submission is recorded in the Wix Forms collection.
34
- */
28
+ /** Status of the submission. */
35
29
  status?: SubmissionStatus;
36
30
  /** Submission values where `key` is the form field and `value` is the data submitted for the given field. */
37
31
  submissions?: Record<string, any>;
@@ -66,9 +60,13 @@ interface FormSubmission {
66
60
  }
67
61
  declare enum SubmissionStatus {
68
62
  UNKNOWN_SUBMISSION_STATUS = "UNKNOWN_SUBMISSION_STATUS",
63
+ /** A submission is created, but has not yet been recorded in the Wix Forms collection. */
69
64
  PENDING = "PENDING",
65
+ /** A submission is recorded in the Wix Forms collection. */
70
66
  CONFIRMED = "CONFIRMED",
67
+ /** A form submission requiring payment is created. */
71
68
  PAYMENT_WAITING = "PAYMENT_WAITING",
69
+ /** An order of a form submission is canceled. */
72
70
  PAYMENT_CANCELED = "PAYMENT_CANCELED"
73
71
  }
74
72
  interface Submitter extends SubmitterSubmitterOneOf {
@@ -131,8 +129,11 @@ interface OrderDetails {
131
129
  checkoutId?: string;
132
130
  }
133
131
  declare enum ActionType {
132
+ /** Unknown action type. */
134
133
  UNKNOWN_ACTION = "UNKNOWN_ACTION",
134
+ /** Update submission. */
135
135
  UPDATE = "UPDATE",
136
+ /** Create submission. */
136
137
  CREATE = "CREATE"
137
138
  }
138
139
  interface UpdateOptions {
@@ -164,35 +165,35 @@ interface SubmissionValidationErrorErrorMessageOneOf {
164
165
  customErrorMessage?: string;
165
166
  }
166
167
  declare enum SubmissionErrorType {
167
- /** Error is unknown or not suitable for any of options bellow */
168
+ /** Error is unknown or unsuitable for any of the options below. */
168
169
  UNKNOWN_ERROR = "UNKNOWN_ERROR",
169
- /** Type of submitted value is incorrect */
170
+ /** Type of submitted value is incorrect. */
170
171
  TYPE_ERROR = "TYPE_ERROR",
171
- /** Value is required to be provided */
172
+ /** Value is required to be provided. */
172
173
  REQUIRED_VALUE_ERROR = "REQUIRED_VALUE_ERROR",
173
- /** Value contains additional properties not expected in schema */
174
+ /** Value contains additional properties not expected in schema. */
174
175
  UNKNOWN_VALUE_ERROR = "UNKNOWN_VALUE_ERROR",
175
- /** Text value exceeds max length */
176
+ /** Text value exceeds max length. */
176
177
  MAX_LENGTH_ERROR = "MAX_LENGTH_ERROR",
177
- /** Text value not reaches min length */
178
+ /** Text value does not reach min length. */
178
179
  MIN_LENGTH_ERROR = "MIN_LENGTH_ERROR",
179
- /** Text value not applicable for expected pattern */
180
+ /** Text value is not applicable for expected pattern. */
180
181
  PATTERN_ERROR = "PATTERN_ERROR",
181
- /** Text value not applicable for expected format */
182
+ /** Text value is not applicable for expected format. */
182
183
  FORMAT_ERROR = "FORMAT_ERROR",
183
- /** Number value is too big */
184
+ /** Number value is too big. */
184
185
  MAX_VALUE_ERROR = "MAX_VALUE_ERROR",
185
- /** Number value is too small */
186
+ /** Number value is too small. */
186
187
  MIN_VALUE_ERROR = "MIN_VALUE_ERROR",
187
- /** Number value is not multiple of expected number */
188
+ /** Number value is not a multiple of expected number. */
188
189
  MULTIPLE_OF_VALUE_ERROR = "MULTIPLE_OF_VALUE_ERROR",
189
- /** Array value has too much items */
190
+ /** Array value has too many items. */
190
191
  MIN_ITEMS_ERROR = "MIN_ITEMS_ERROR",
191
- /** Array value has not enough items */
192
+ /** Array value has not enough items. */
192
193
  MAX_ITEMS_ERROR = "MAX_ITEMS_ERROR",
193
- /** Value is not in list of allowed values */
194
+ /** Value is not in the list of allowed values. */
194
195
  NOT_ALLOWED_VALUE_ERROR = "NOT_ALLOWED_VALUE_ERROR",
195
- /** Submitted form is disabled */
196
+ /** Submitted form is disabled. */
196
197
  DISABLED_FORM_ERROR = "DISABLED_FORM_ERROR"
197
198
  }
198
199
  interface FormSubmissionSpiExtensionConfig {