@wix/auto_sdk_forms_submissions 1.0.27 → 1.0.28

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.
Files changed (127) hide show
  1. package/build/{internal/cjs/src/forms-v4-submission-submissions.universal.d.ts → cjs/forms-v4-submission-submissions.universal-Q3Bs_Jbt.d.ts} +1534 -1205
  2. package/build/cjs/index.d.ts +327 -1
  3. package/build/cjs/index.js +2974 -15
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +28 -1
  6. package/build/cjs/index.typings.js +2605 -15
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1043 -1
  9. package/build/cjs/meta.js +1277 -15
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/{internal/es/src/forms-v4-submission-submissions.universal.d.ts → es/forms-v4-submission-submissions.universal-Q3Bs_Jbt.d.mts} +1534 -1205
  12. package/build/es/index.d.mts +327 -0
  13. package/build/es/index.mjs +2815 -0
  14. package/build/es/index.mjs.map +1 -0
  15. package/build/es/index.typings.d.mts +28 -0
  16. package/build/es/index.typings.mjs +2453 -0
  17. package/build/es/index.typings.mjs.map +1 -0
  18. package/build/es/meta.d.mts +1043 -0
  19. package/build/es/meta.mjs +1228 -0
  20. package/build/es/meta.mjs.map +1 -0
  21. package/build/{cjs/src/forms-v4-submission-submissions.universal.d.ts → internal/cjs/forms-v4-submission-submissions.universal-ILKHqisa.d.ts} +1561 -1170
  22. package/build/internal/cjs/index.d.ts +349 -1
  23. package/build/internal/cjs/index.js +2974 -15
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +28 -1
  26. package/build/internal/cjs/index.typings.js +2605 -15
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +1043 -1
  29. package/build/internal/cjs/meta.js +1277 -15
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/{es/src/forms-v4-submission-submissions.universal.d.ts → internal/es/forms-v4-submission-submissions.universal-ILKHqisa.d.mts} +1561 -1170
  32. package/build/internal/es/index.d.mts +349 -0
  33. package/build/internal/es/index.mjs +2815 -0
  34. package/build/internal/es/index.mjs.map +1 -0
  35. package/build/internal/es/index.typings.d.mts +28 -0
  36. package/build/internal/es/index.typings.mjs +2453 -0
  37. package/build/internal/es/index.typings.mjs.map +1 -0
  38. package/build/internal/es/meta.d.mts +1043 -0
  39. package/build/internal/es/meta.mjs +1228 -0
  40. package/build/internal/es/meta.mjs.map +1 -0
  41. package/package.json +12 -10
  42. package/build/cjs/src/forms-v4-submission-submissions.context.d.ts +0 -65
  43. package/build/cjs/src/forms-v4-submission-submissions.context.js +0 -170
  44. package/build/cjs/src/forms-v4-submission-submissions.context.js.map +0 -1
  45. package/build/cjs/src/forms-v4-submission-submissions.http.d.ts +0 -126
  46. package/build/cjs/src/forms-v4-submission-submissions.http.js +0 -849
  47. package/build/cjs/src/forms-v4-submission-submissions.http.js.map +0 -1
  48. package/build/cjs/src/forms-v4-submission-submissions.meta.d.ts +0 -58
  49. package/build/cjs/src/forms-v4-submission-submissions.meta.js +0 -522
  50. package/build/cjs/src/forms-v4-submission-submissions.meta.js.map +0 -1
  51. package/build/cjs/src/forms-v4-submission-submissions.public.d.ts +0 -268
  52. package/build/cjs/src/forms-v4-submission-submissions.public.js +0 -332
  53. package/build/cjs/src/forms-v4-submission-submissions.public.js.map +0 -1
  54. package/build/cjs/src/forms-v4-submission-submissions.types.d.ts +0 -6288
  55. package/build/cjs/src/forms-v4-submission-submissions.types.js +0 -961
  56. package/build/cjs/src/forms-v4-submission-submissions.types.js.map +0 -1
  57. package/build/cjs/src/forms-v4-submission-submissions.universal.js +0 -2217
  58. package/build/cjs/src/forms-v4-submission-submissions.universal.js.map +0 -1
  59. package/build/es/index.d.ts +0 -1
  60. package/build/es/index.js +0 -2
  61. package/build/es/index.js.map +0 -1
  62. package/build/es/index.typings.d.ts +0 -1
  63. package/build/es/index.typings.js +0 -2
  64. package/build/es/index.typings.js.map +0 -1
  65. package/build/es/meta.d.ts +0 -1
  66. package/build/es/meta.js +0 -2
  67. package/build/es/meta.js.map +0 -1
  68. package/build/es/src/forms-v4-submission-submissions.context.d.ts +0 -65
  69. package/build/es/src/forms-v4-submission-submissions.context.js +0 -69
  70. package/build/es/src/forms-v4-submission-submissions.context.js.map +0 -1
  71. package/build/es/src/forms-v4-submission-submissions.http.d.ts +0 -126
  72. package/build/es/src/forms-v4-submission-submissions.http.js +0 -820
  73. package/build/es/src/forms-v4-submission-submissions.http.js.map +0 -1
  74. package/build/es/src/forms-v4-submission-submissions.meta.d.ts +0 -58
  75. package/build/es/src/forms-v4-submission-submissions.meta.js +0 -470
  76. package/build/es/src/forms-v4-submission-submissions.meta.js.map +0 -1
  77. package/build/es/src/forms-v4-submission-submissions.public.d.ts +0 -268
  78. package/build/es/src/forms-v4-submission-submissions.public.js +0 -205
  79. package/build/es/src/forms-v4-submission-submissions.public.js.map +0 -1
  80. package/build/es/src/forms-v4-submission-submissions.types.d.ts +0 -6288
  81. package/build/es/src/forms-v4-submission-submissions.types.js +0 -957
  82. package/build/es/src/forms-v4-submission-submissions.types.js.map +0 -1
  83. package/build/es/src/forms-v4-submission-submissions.universal.js +0 -2163
  84. package/build/es/src/forms-v4-submission-submissions.universal.js.map +0 -1
  85. package/build/internal/cjs/src/forms-v4-submission-submissions.context.d.ts +0 -69
  86. package/build/internal/cjs/src/forms-v4-submission-submissions.context.js +0 -170
  87. package/build/internal/cjs/src/forms-v4-submission-submissions.context.js.map +0 -1
  88. package/build/internal/cjs/src/forms-v4-submission-submissions.http.d.ts +0 -126
  89. package/build/internal/cjs/src/forms-v4-submission-submissions.http.js +0 -849
  90. package/build/internal/cjs/src/forms-v4-submission-submissions.http.js.map +0 -1
  91. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.d.ts +0 -58
  92. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js +0 -522
  93. package/build/internal/cjs/src/forms-v4-submission-submissions.meta.js.map +0 -1
  94. package/build/internal/cjs/src/forms-v4-submission-submissions.public.d.ts +0 -286
  95. package/build/internal/cjs/src/forms-v4-submission-submissions.public.js +0 -332
  96. package/build/internal/cjs/src/forms-v4-submission-submissions.public.js.map +0 -1
  97. package/build/internal/cjs/src/forms-v4-submission-submissions.types.d.ts +0 -6288
  98. package/build/internal/cjs/src/forms-v4-submission-submissions.types.js +0 -961
  99. package/build/internal/cjs/src/forms-v4-submission-submissions.types.js.map +0 -1
  100. package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js +0 -2217
  101. package/build/internal/cjs/src/forms-v4-submission-submissions.universal.js.map +0 -1
  102. package/build/internal/es/index.d.ts +0 -1
  103. package/build/internal/es/index.js +0 -2
  104. package/build/internal/es/index.js.map +0 -1
  105. package/build/internal/es/index.typings.d.ts +0 -1
  106. package/build/internal/es/index.typings.js +0 -2
  107. package/build/internal/es/index.typings.js.map +0 -1
  108. package/build/internal/es/meta.d.ts +0 -1
  109. package/build/internal/es/meta.js +0 -2
  110. package/build/internal/es/meta.js.map +0 -1
  111. package/build/internal/es/src/forms-v4-submission-submissions.context.d.ts +0 -69
  112. package/build/internal/es/src/forms-v4-submission-submissions.context.js +0 -69
  113. package/build/internal/es/src/forms-v4-submission-submissions.context.js.map +0 -1
  114. package/build/internal/es/src/forms-v4-submission-submissions.http.d.ts +0 -126
  115. package/build/internal/es/src/forms-v4-submission-submissions.http.js +0 -820
  116. package/build/internal/es/src/forms-v4-submission-submissions.http.js.map +0 -1
  117. package/build/internal/es/src/forms-v4-submission-submissions.meta.d.ts +0 -58
  118. package/build/internal/es/src/forms-v4-submission-submissions.meta.js +0 -470
  119. package/build/internal/es/src/forms-v4-submission-submissions.meta.js.map +0 -1
  120. package/build/internal/es/src/forms-v4-submission-submissions.public.d.ts +0 -286
  121. package/build/internal/es/src/forms-v4-submission-submissions.public.js +0 -205
  122. package/build/internal/es/src/forms-v4-submission-submissions.public.js.map +0 -1
  123. package/build/internal/es/src/forms-v4-submission-submissions.types.d.ts +0 -6288
  124. package/build/internal/es/src/forms-v4-submission-submissions.types.js +0 -957
  125. package/build/internal/es/src/forms-v4-submission-submissions.types.js.map +0 -1
  126. package/build/internal/es/src/forms-v4-submission-submissions.universal.js +0 -2163
  127. package/build/internal/es/src/forms-v4-submission-submissions.universal.js.map +0 -1
@@ -1,2163 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { queryBuilder } from '@wix/sdk-runtime/query-builder';
3
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
4
- import * as ambassadorWixFormsV4Submission from './forms-v4-submission-submissions.http.js';
5
- export var SubmissionStatus;
6
- (function (SubmissionStatus) {
7
- SubmissionStatus["UNKNOWN_SUBMISSION_STATUS"] = "UNKNOWN_SUBMISSION_STATUS";
8
- /** A submission is created, but has not yet been recorded in the Wix Forms collection. */
9
- SubmissionStatus["PENDING"] = "PENDING";
10
- /** A submission is recorded in the Wix Forms collection. */
11
- SubmissionStatus["CONFIRMED"] = "CONFIRMED";
12
- /** A form submission requiring payment is created. */
13
- SubmissionStatus["PAYMENT_WAITING"] = "PAYMENT_WAITING";
14
- /** An order of a form submission is canceled. */
15
- SubmissionStatus["PAYMENT_CANCELED"] = "PAYMENT_CANCELED";
16
- })(SubmissionStatus || (SubmissionStatus = {}));
17
- export var OptInLevel;
18
- (function (OptInLevel) {
19
- /** Single confirmation. */
20
- OptInLevel["SINGLE_CONFIRMATION"] = "SINGLE_CONFIRMATION";
21
- /** Double confirmation. */
22
- OptInLevel["DOUBLE_CONFIRMATION"] = "DOUBLE_CONFIRMATION";
23
- })(OptInLevel || (OptInLevel = {}));
24
- export var StringTypeFormatEnumFormat;
25
- (function (StringTypeFormatEnumFormat) {
26
- StringTypeFormatEnumFormat["UNDEFINED"] = "UNDEFINED";
27
- StringTypeFormatEnumFormat["DATE"] = "DATE";
28
- StringTypeFormatEnumFormat["TIME"] = "TIME";
29
- StringTypeFormatEnumFormat["DATE_TIME"] = "DATE_TIME";
30
- StringTypeFormatEnumFormat["EMAIL"] = "EMAIL";
31
- StringTypeFormatEnumFormat["URL"] = "URL";
32
- StringTypeFormatEnumFormat["UUID"] = "UUID";
33
- StringTypeFormatEnumFormat["PHONE"] = "PHONE";
34
- StringTypeFormatEnumFormat["URI"] = "URI";
35
- StringTypeFormatEnumFormat["HOSTNAME"] = "HOSTNAME";
36
- StringTypeFormatEnumFormat["COLOR_HEX"] = "COLOR_HEX";
37
- StringTypeFormatEnumFormat["CURRENCY"] = "CURRENCY";
38
- StringTypeFormatEnumFormat["LANGUAGE"] = "LANGUAGE";
39
- StringTypeFormatEnumFormat["DATE_OPTIONAL_TIME"] = "DATE_OPTIONAL_TIME";
40
- })(StringTypeFormatEnumFormat || (StringTypeFormatEnumFormat = {}));
41
- export var ValidationFormat;
42
- (function (ValidationFormat) {
43
- ValidationFormat["UNDEFINED"] = "UNDEFINED";
44
- /** File upload validation. */
45
- ValidationFormat["WIX_FILE"] = "WIX_FILE";
46
- /** Payment validation. */
47
- ValidationFormat["PAYMENT"] = "PAYMENT";
48
- /** Multiline address. */
49
- ValidationFormat["MULTILINE_ADDRESS"] = "MULTILINE_ADDRESS";
50
- /** Scheduling validation. */
51
- ValidationFormat["SCHEDULING"] = "SCHEDULING";
52
- })(ValidationFormat || (ValidationFormat = {}));
53
- export var ProductType;
54
- (function (ProductType) {
55
- /** Unknown product type. */
56
- ProductType["UNKNOWN"] = "UNKNOWN";
57
- /** Shippable (physical) product. */
58
- ProductType["SHIPPABLE"] = "SHIPPABLE";
59
- /** Digital product. */
60
- ProductType["DIGITAL"] = "DIGITAL";
61
- })(ProductType || (ProductType = {}));
62
- export var PriceType;
63
- (function (PriceType) {
64
- /** Unknown price type. */
65
- PriceType["UNKNOWN"] = "UNKNOWN";
66
- /** Fixed price. */
67
- PriceType["FIXED_PRICE"] = "FIXED_PRICE";
68
- /** Dynamic price from price range. */
69
- PriceType["DYNAMIC_PRICE"] = "DYNAMIC_PRICE";
70
- })(PriceType || (PriceType = {}));
71
- export var InputFieldStringTypeFormatEnumFormat;
72
- (function (InputFieldStringTypeFormatEnumFormat) {
73
- InputFieldStringTypeFormatEnumFormat["UNKNOWN_FORMAT"] = "UNKNOWN_FORMAT";
74
- InputFieldStringTypeFormatEnumFormat["DATE"] = "DATE";
75
- InputFieldStringTypeFormatEnumFormat["TIME"] = "TIME";
76
- InputFieldStringTypeFormatEnumFormat["DATE_TIME"] = "DATE_TIME";
77
- InputFieldStringTypeFormatEnumFormat["EMAIL"] = "EMAIL";
78
- InputFieldStringTypeFormatEnumFormat["URL"] = "URL";
79
- InputFieldStringTypeFormatEnumFormat["UUID"] = "UUID";
80
- InputFieldStringTypeFormatEnumFormat["PHONE"] = "PHONE";
81
- InputFieldStringTypeFormatEnumFormat["URI"] = "URI";
82
- InputFieldStringTypeFormatEnumFormat["HOSTNAME"] = "HOSTNAME";
83
- InputFieldStringTypeFormatEnumFormat["COLOR_HEX"] = "COLOR_HEX";
84
- InputFieldStringTypeFormatEnumFormat["CURRENCY"] = "CURRENCY";
85
- InputFieldStringTypeFormatEnumFormat["LANGUAGE"] = "LANGUAGE";
86
- InputFieldStringTypeFormatEnumFormat["DATE_OPTIONAL_TIME"] = "DATE_OPTIONAL_TIME";
87
- })(InputFieldStringTypeFormatEnumFormat || (InputFieldStringTypeFormatEnumFormat = {}));
88
- export var InputFieldStringComponentType;
89
- (function (InputFieldStringComponentType) {
90
- InputFieldStringComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
91
- InputFieldStringComponentType["TEXT_INPUT"] = "TEXT_INPUT";
92
- InputFieldStringComponentType["RADIO_GROUP"] = "RADIO_GROUP";
93
- InputFieldStringComponentType["DROPDOWN"] = "DROPDOWN";
94
- InputFieldStringComponentType["DATE_TIME"] = "DATE_TIME";
95
- InputFieldStringComponentType["PHONE_INPUT"] = "PHONE_INPUT";
96
- InputFieldStringComponentType["DATE_INPUT"] = "DATE_INPUT";
97
- InputFieldStringComponentType["TIME_INPUT"] = "TIME_INPUT";
98
- InputFieldStringComponentType["DATE_PICKER"] = "DATE_PICKER";
99
- })(InputFieldStringComponentType || (InputFieldStringComponentType = {}));
100
- export var NodeType;
101
- (function (NodeType) {
102
- NodeType["PARAGRAPH"] = "PARAGRAPH";
103
- NodeType["TEXT"] = "TEXT";
104
- NodeType["HEADING"] = "HEADING";
105
- NodeType["BULLETED_LIST"] = "BULLETED_LIST";
106
- NodeType["ORDERED_LIST"] = "ORDERED_LIST";
107
- NodeType["LIST_ITEM"] = "LIST_ITEM";
108
- NodeType["BLOCKQUOTE"] = "BLOCKQUOTE";
109
- NodeType["CODE_BLOCK"] = "CODE_BLOCK";
110
- NodeType["VIDEO"] = "VIDEO";
111
- NodeType["DIVIDER"] = "DIVIDER";
112
- NodeType["FILE"] = "FILE";
113
- NodeType["GALLERY"] = "GALLERY";
114
- NodeType["GIF"] = "GIF";
115
- NodeType["HTML"] = "HTML";
116
- NodeType["IMAGE"] = "IMAGE";
117
- NodeType["LINK_PREVIEW"] = "LINK_PREVIEW";
118
- /** @deprecated */
119
- NodeType["MAP"] = "MAP";
120
- NodeType["POLL"] = "POLL";
121
- NodeType["APP_EMBED"] = "APP_EMBED";
122
- NodeType["BUTTON"] = "BUTTON";
123
- NodeType["COLLAPSIBLE_LIST"] = "COLLAPSIBLE_LIST";
124
- NodeType["TABLE"] = "TABLE";
125
- NodeType["EMBED"] = "EMBED";
126
- NodeType["COLLAPSIBLE_ITEM"] = "COLLAPSIBLE_ITEM";
127
- NodeType["COLLAPSIBLE_ITEM_TITLE"] = "COLLAPSIBLE_ITEM_TITLE";
128
- NodeType["COLLAPSIBLE_ITEM_BODY"] = "COLLAPSIBLE_ITEM_BODY";
129
- NodeType["TABLE_CELL"] = "TABLE_CELL";
130
- NodeType["TABLE_ROW"] = "TABLE_ROW";
131
- NodeType["EXTERNAL"] = "EXTERNAL";
132
- NodeType["AUDIO"] = "AUDIO";
133
- NodeType["CAPTION"] = "CAPTION";
134
- NodeType["LAYOUT"] = "LAYOUT";
135
- NodeType["LAYOUT_CELL"] = "LAYOUT_CELL";
136
- })(NodeType || (NodeType = {}));
137
- export var WidthType;
138
- (function (WidthType) {
139
- /** Width matches the content width */
140
- WidthType["CONTENT"] = "CONTENT";
141
- /** Small Width */
142
- WidthType["SMALL"] = "SMALL";
143
- /** Width will match the original asset width */
144
- WidthType["ORIGINAL"] = "ORIGINAL";
145
- /** coast-to-coast display */
146
- WidthType["FULL_WIDTH"] = "FULL_WIDTH";
147
- })(WidthType || (WidthType = {}));
148
- export var PluginContainerDataAlignment;
149
- (function (PluginContainerDataAlignment) {
150
- /** Center Alignment */
151
- PluginContainerDataAlignment["CENTER"] = "CENTER";
152
- /** Left Alignment */
153
- PluginContainerDataAlignment["LEFT"] = "LEFT";
154
- /** Right Alignment */
155
- PluginContainerDataAlignment["RIGHT"] = "RIGHT";
156
- })(PluginContainerDataAlignment || (PluginContainerDataAlignment = {}));
157
- export var ButtonDataType;
158
- (function (ButtonDataType) {
159
- /** Regular link button */
160
- ButtonDataType["LINK"] = "LINK";
161
- /** Triggers custom action that is defined in plugin configuration by the consumer */
162
- ButtonDataType["ACTION"] = "ACTION";
163
- })(ButtonDataType || (ButtonDataType = {}));
164
- export var LinkTarget;
165
- (function (LinkTarget) {
166
- /** Opens the linked document in the same frame as it was clicked (this is default) */
167
- LinkTarget["SELF"] = "SELF";
168
- /** Opens the linked document in a new window or tab */
169
- LinkTarget["BLANK"] = "BLANK";
170
- /** Opens the linked document in the parent frame */
171
- LinkTarget["PARENT"] = "PARENT";
172
- /** Opens the linked document in the full body of the window */
173
- LinkTarget["TOP"] = "TOP";
174
- })(LinkTarget || (LinkTarget = {}));
175
- export var TextAlignment;
176
- (function (TextAlignment) {
177
- /** browser default, eqivalent to `initial` */
178
- TextAlignment["AUTO"] = "AUTO";
179
- /** Left align */
180
- TextAlignment["LEFT"] = "LEFT";
181
- /** Right align */
182
- TextAlignment["RIGHT"] = "RIGHT";
183
- /** Center align */
184
- TextAlignment["CENTER"] = "CENTER";
185
- /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
186
- TextAlignment["JUSTIFY"] = "JUSTIFY";
187
- })(TextAlignment || (TextAlignment = {}));
188
- export var LineStyle;
189
- (function (LineStyle) {
190
- /** Single Line */
191
- LineStyle["SINGLE"] = "SINGLE";
192
- /** Double Line */
193
- LineStyle["DOUBLE"] = "DOUBLE";
194
- /** Dashed Line */
195
- LineStyle["DASHED"] = "DASHED";
196
- /** Dotted Line */
197
- LineStyle["DOTTED"] = "DOTTED";
198
- })(LineStyle || (LineStyle = {}));
199
- export var Width;
200
- (function (Width) {
201
- /** Large line */
202
- Width["LARGE"] = "LARGE";
203
- /** Medium line */
204
- Width["MEDIUM"] = "MEDIUM";
205
- /** Small line */
206
- Width["SMALL"] = "SMALL";
207
- })(Width || (Width = {}));
208
- export var Alignment;
209
- (function (Alignment) {
210
- /** Center alignment */
211
- Alignment["CENTER"] = "CENTER";
212
- /** Left alignment */
213
- Alignment["LEFT"] = "LEFT";
214
- /** Right alignment */
215
- Alignment["RIGHT"] = "RIGHT";
216
- })(Alignment || (Alignment = {}));
217
- export var ViewMode;
218
- (function (ViewMode) {
219
- /** No PDF view */
220
- ViewMode["NONE"] = "NONE";
221
- /** Full PDF view */
222
- ViewMode["FULL"] = "FULL";
223
- /** Mini PDF view */
224
- ViewMode["MINI"] = "MINI";
225
- })(ViewMode || (ViewMode = {}));
226
- export var LayoutType;
227
- (function (LayoutType) {
228
- /** Collage type */
229
- LayoutType["COLLAGE"] = "COLLAGE";
230
- /** Masonry type */
231
- LayoutType["MASONRY"] = "MASONRY";
232
- /** Grid type */
233
- LayoutType["GRID"] = "GRID";
234
- /** Thumbnail type */
235
- LayoutType["THUMBNAIL"] = "THUMBNAIL";
236
- /** Slider type */
237
- LayoutType["SLIDER"] = "SLIDER";
238
- /** Slideshow type */
239
- LayoutType["SLIDESHOW"] = "SLIDESHOW";
240
- /** Panorama type */
241
- LayoutType["PANORAMA"] = "PANORAMA";
242
- /** Column type */
243
- LayoutType["COLUMN"] = "COLUMN";
244
- /** Magic type */
245
- LayoutType["MAGIC"] = "MAGIC";
246
- /** Fullsize images type */
247
- LayoutType["FULLSIZE"] = "FULLSIZE";
248
- })(LayoutType || (LayoutType = {}));
249
- export var Orientation;
250
- (function (Orientation) {
251
- /** Rows Orientation */
252
- Orientation["ROWS"] = "ROWS";
253
- /** Columns Orientation */
254
- Orientation["COLUMNS"] = "COLUMNS";
255
- })(Orientation || (Orientation = {}));
256
- export var Crop;
257
- (function (Crop) {
258
- /** Crop to fill */
259
- Crop["FILL"] = "FILL";
260
- /** Crop to fit */
261
- Crop["FIT"] = "FIT";
262
- })(Crop || (Crop = {}));
263
- export var ThumbnailsAlignment;
264
- (function (ThumbnailsAlignment) {
265
- /** Top alignment */
266
- ThumbnailsAlignment["TOP"] = "TOP";
267
- /** Right alignment */
268
- ThumbnailsAlignment["RIGHT"] = "RIGHT";
269
- /** Bottom alignment */
270
- ThumbnailsAlignment["BOTTOM"] = "BOTTOM";
271
- /** Left alignment */
272
- ThumbnailsAlignment["LEFT"] = "LEFT";
273
- /** No thumbnail */
274
- ThumbnailsAlignment["NONE"] = "NONE";
275
- })(ThumbnailsAlignment || (ThumbnailsAlignment = {}));
276
- export var GIFType;
277
- (function (GIFType) {
278
- GIFType["NORMAL"] = "NORMAL";
279
- GIFType["STICKER"] = "STICKER";
280
- })(GIFType || (GIFType = {}));
281
- export var Source;
282
- (function (Source) {
283
- Source["HTML"] = "HTML";
284
- Source["ADSENSE"] = "ADSENSE";
285
- })(Source || (Source = {}));
286
- export var Position;
287
- (function (Position) {
288
- /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
289
- Position["START"] = "START";
290
- /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
291
- Position["END"] = "END";
292
- /** Thumbnail positioned at the top */
293
- Position["TOP"] = "TOP";
294
- /** Thumbnail hidden and not displayed */
295
- Position["HIDDEN"] = "HIDDEN";
296
- })(Position || (Position = {}));
297
- export var MapType;
298
- (function (MapType) {
299
- /** Roadmap map type */
300
- MapType["ROADMAP"] = "ROADMAP";
301
- /** Satellite map type */
302
- MapType["SATELITE"] = "SATELITE";
303
- /** Hybrid map type */
304
- MapType["HYBRID"] = "HYBRID";
305
- /** Terrain map type */
306
- MapType["TERRAIN"] = "TERRAIN";
307
- })(MapType || (MapType = {}));
308
- export var ViewRole;
309
- (function (ViewRole) {
310
- /** Only Poll creator can view the results */
311
- ViewRole["CREATOR"] = "CREATOR";
312
- /** Anyone who voted can see the results */
313
- ViewRole["VOTERS"] = "VOTERS";
314
- /** Anyone can see the results, even if one didn't vote */
315
- ViewRole["EVERYONE"] = "EVERYONE";
316
- })(ViewRole || (ViewRole = {}));
317
- export var VoteRole;
318
- (function (VoteRole) {
319
- /** Logged in member */
320
- VoteRole["SITE_MEMBERS"] = "SITE_MEMBERS";
321
- /** Anyone */
322
- VoteRole["ALL"] = "ALL";
323
- })(VoteRole || (VoteRole = {}));
324
- export var PollLayoutType;
325
- (function (PollLayoutType) {
326
- /** List */
327
- PollLayoutType["LIST"] = "LIST";
328
- /** Grid */
329
- PollLayoutType["GRID"] = "GRID";
330
- })(PollLayoutType || (PollLayoutType = {}));
331
- export var PollLayoutDirection;
332
- (function (PollLayoutDirection) {
333
- /** Left-to-right */
334
- PollLayoutDirection["LTR"] = "LTR";
335
- /** Right-to-left */
336
- PollLayoutDirection["RTL"] = "RTL";
337
- })(PollLayoutDirection || (PollLayoutDirection = {}));
338
- export var BackgroundType;
339
- (function (BackgroundType) {
340
- /** Color background type */
341
- BackgroundType["COLOR"] = "COLOR";
342
- /** Image background type */
343
- BackgroundType["IMAGE"] = "IMAGE";
344
- /** Gradiant background type */
345
- BackgroundType["GRADIENT"] = "GRADIENT";
346
- })(BackgroundType || (BackgroundType = {}));
347
- export var DecorationType;
348
- (function (DecorationType) {
349
- DecorationType["BOLD"] = "BOLD";
350
- DecorationType["ITALIC"] = "ITALIC";
351
- DecorationType["UNDERLINE"] = "UNDERLINE";
352
- DecorationType["SPOILER"] = "SPOILER";
353
- DecorationType["ANCHOR"] = "ANCHOR";
354
- DecorationType["MENTION"] = "MENTION";
355
- DecorationType["LINK"] = "LINK";
356
- DecorationType["COLOR"] = "COLOR";
357
- DecorationType["FONT_SIZE"] = "FONT_SIZE";
358
- DecorationType["EXTERNAL"] = "EXTERNAL";
359
- })(DecorationType || (DecorationType = {}));
360
- export var FontType;
361
- (function (FontType) {
362
- FontType["PX"] = "PX";
363
- FontType["EM"] = "EM";
364
- })(FontType || (FontType = {}));
365
- export var AppType;
366
- (function (AppType) {
367
- AppType["PRODUCT"] = "PRODUCT";
368
- AppType["EVENT"] = "EVENT";
369
- AppType["BOOKING"] = "BOOKING";
370
- })(AppType || (AppType = {}));
371
- export var InitialExpandedItems;
372
- (function (InitialExpandedItems) {
373
- /** First item will be expended initally */
374
- InitialExpandedItems["FIRST"] = "FIRST";
375
- /** All items will expended initally */
376
- InitialExpandedItems["ALL"] = "ALL";
377
- /** All items collapsed initally */
378
- InitialExpandedItems["NONE"] = "NONE";
379
- })(InitialExpandedItems || (InitialExpandedItems = {}));
380
- export var Direction;
381
- (function (Direction) {
382
- /** Left-to-right */
383
- Direction["LTR"] = "LTR";
384
- /** Right-to-left */
385
- Direction["RTL"] = "RTL";
386
- })(Direction || (Direction = {}));
387
- export var VerticalAlignment;
388
- (function (VerticalAlignment) {
389
- /** Top alignment */
390
- VerticalAlignment["TOP"] = "TOP";
391
- /** Middle alignment */
392
- VerticalAlignment["MIDDLE"] = "MIDDLE";
393
- /** Bottom alignment */
394
- VerticalAlignment["BOTTOM"] = "BOTTOM";
395
- })(VerticalAlignment || (VerticalAlignment = {}));
396
- /**
397
- * `NullValue` is a singleton enumeration to represent the null value for the
398
- * `Value` type union.
399
- *
400
- * The JSON representation for `NullValue` is JSON `null`.
401
- */
402
- export var NullValue;
403
- (function (NullValue) {
404
- /** Null value. */
405
- NullValue["NULL_VALUE"] = "NULL_VALUE";
406
- })(NullValue || (NullValue = {}));
407
- export var NumberOfColumns;
408
- (function (NumberOfColumns) {
409
- /** Undefined number of columns. */
410
- NumberOfColumns["UNKNOWN"] = "UNKNOWN";
411
- /** Zero columns. */
412
- NumberOfColumns["ZERO"] = "ZERO";
413
- /** One column. */
414
- NumberOfColumns["ONE"] = "ONE";
415
- /** Two columns. */
416
- NumberOfColumns["TWO"] = "TWO";
417
- /** Three columns. */
418
- NumberOfColumns["THREE"] = "THREE";
419
- })(NumberOfColumns || (NumberOfColumns = {}));
420
- export var FirstDayOfWeek;
421
- (function (FirstDayOfWeek) {
422
- /** First day of the week is Monday. */
423
- FirstDayOfWeek["MONDAY"] = "MONDAY";
424
- /** First day of the week is Sunday. */
425
- FirstDayOfWeek["SUNDAY"] = "SUNDAY";
426
- })(FirstDayOfWeek || (FirstDayOfWeek = {}));
427
- export var InputFieldNumberComponentType;
428
- (function (InputFieldNumberComponentType) {
429
- InputFieldNumberComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
430
- InputFieldNumberComponentType["NUMBER_INPUT"] = "NUMBER_INPUT";
431
- InputFieldNumberComponentType["RATING_INPUT"] = "RATING_INPUT";
432
- })(InputFieldNumberComponentType || (InputFieldNumberComponentType = {}));
433
- export var InputFieldBooleanComponentType;
434
- (function (InputFieldBooleanComponentType) {
435
- InputFieldBooleanComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
436
- InputFieldBooleanComponentType["CHECKBOX"] = "CHECKBOX";
437
- })(InputFieldBooleanComponentType || (InputFieldBooleanComponentType = {}));
438
- export var ArrayItemsItemType;
439
- (function (ArrayItemsItemType) {
440
- ArrayItemsItemType["UNKNOWN_ITEM_TYPE"] = "UNKNOWN_ITEM_TYPE";
441
- ArrayItemsItemType["STRING"] = "STRING";
442
- ArrayItemsItemType["NUMBER"] = "NUMBER";
443
- ArrayItemsItemType["BOOLEAN"] = "BOOLEAN";
444
- ArrayItemsItemType["INTEGER"] = "INTEGER";
445
- ArrayItemsItemType["OBJECT"] = "OBJECT";
446
- })(ArrayItemsItemType || (ArrayItemsItemType = {}));
447
- export var PropertiesTypePropertiesTypeEnum;
448
- (function (PropertiesTypePropertiesTypeEnum) {
449
- PropertiesTypePropertiesTypeEnum["UNKNOWN_PROPERTIES_TYPE"] = "UNKNOWN_PROPERTIES_TYPE";
450
- PropertiesTypePropertiesTypeEnum["STRING"] = "STRING";
451
- PropertiesTypePropertiesTypeEnum["NUMBER"] = "NUMBER";
452
- PropertiesTypePropertiesTypeEnum["BOOLEAN"] = "BOOLEAN";
453
- PropertiesTypePropertiesTypeEnum["INTEGER"] = "INTEGER";
454
- PropertiesTypePropertiesTypeEnum["ARRAY"] = "ARRAY";
455
- })(PropertiesTypePropertiesTypeEnum || (PropertiesTypePropertiesTypeEnum = {}));
456
- export var ArrayComponentType;
457
- (function (ArrayComponentType) {
458
- ArrayComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
459
- ArrayComponentType["CHECKBOX_GROUP"] = "CHECKBOX_GROUP";
460
- ArrayComponentType["TAGS"] = "TAGS";
461
- })(ArrayComponentType || (ArrayComponentType = {}));
462
- export var InputFieldWixFileComponentType;
463
- (function (InputFieldWixFileComponentType) {
464
- InputFieldWixFileComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
465
- InputFieldWixFileComponentType["FILE_UPLOAD"] = "FILE_UPLOAD";
466
- InputFieldWixFileComponentType["SIGNATURE"] = "SIGNATURE";
467
- })(InputFieldWixFileComponentType || (InputFieldWixFileComponentType = {}));
468
- export var UploadFileFormat;
469
- (function (UploadFileFormat) {
470
- /** Undefined upload file format. */
471
- UploadFileFormat["UNDEFINED"] = "UNDEFINED";
472
- /** Video files. */
473
- UploadFileFormat["VIDEO"] = "VIDEO";
474
- /** Image files. */
475
- UploadFileFormat["IMAGE"] = "IMAGE";
476
- /** Audio files. */
477
- UploadFileFormat["AUDIO"] = "AUDIO";
478
- /** Document files. */
479
- UploadFileFormat["DOCUMENT"] = "DOCUMENT";
480
- /** Archive files. */
481
- UploadFileFormat["ARCHIVE"] = "ARCHIVE";
482
- })(UploadFileFormat || (UploadFileFormat = {}));
483
- export var InputFieldPaymentComponentType;
484
- (function (InputFieldPaymentComponentType) {
485
- InputFieldPaymentComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
486
- InputFieldPaymentComponentType["CHECKBOX_GROUP"] = "CHECKBOX_GROUP";
487
- InputFieldPaymentComponentType["DONATION_INPUT"] = "DONATION_INPUT";
488
- InputFieldPaymentComponentType["PAYMENT_INPUT"] = "PAYMENT_INPUT";
489
- InputFieldPaymentComponentType["FIXED_PAYMENT"] = "FIXED_PAYMENT";
490
- })(InputFieldPaymentComponentType || (InputFieldPaymentComponentType = {}));
491
- export var ImageFit;
492
- (function (ImageFit) {
493
- ImageFit["UNKNOWN_IMAGE_FIT"] = "UNKNOWN_IMAGE_FIT";
494
- /** Image is scaled to maintain its aspect ratio while filling the element's entire content box. Portions of the image may be clipped if the aspect ratios do not match. */
495
- ImageFit["COVER"] = "COVER";
496
- /** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */
497
- ImageFit["CONTAIN"] = "CONTAIN";
498
- })(ImageFit || (ImageFit = {}));
499
- export var SchedulingComponentType;
500
- (function (SchedulingComponentType) {
501
- SchedulingComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
502
- SchedulingComponentType["APPOINTMENT"] = "APPOINTMENT";
503
- })(SchedulingComponentType || (SchedulingComponentType = {}));
504
- export var Format;
505
- (function (Format) {
506
- Format["UNKNOWN_FORMAT_TYPE"] = "UNKNOWN_FORMAT_TYPE";
507
- Format["IN_PERSON"] = "IN_PERSON";
508
- Format["VIDEO_CONFERENCE"] = "VIDEO_CONFERENCE";
509
- Format["PHONE"] = "PHONE";
510
- })(Format || (Format = {}));
511
- export var InputFieldMultilineAddressComponentType;
512
- (function (InputFieldMultilineAddressComponentType) {
513
- InputFieldMultilineAddressComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
514
- InputFieldMultilineAddressComponentType["MULTILINE_ADDRESS"] = "MULTILINE_ADDRESS";
515
- })(InputFieldMultilineAddressComponentType || (InputFieldMultilineAddressComponentType = {}));
516
- export var Type;
517
- (function (Type) {
518
- /** Unknown default country config type. */
519
- Type["UNKNOWN_DEFAULT_COUNTRY"] = "UNKNOWN_DEFAULT_COUNTRY";
520
- /** Country is determined by customer's IP address. */
521
- Type["BY_IP"] = "BY_IP";
522
- /** Pre-selected default country. */
523
- Type["COUNTRY"] = "COUNTRY";
524
- })(Type || (Type = {}));
525
- export var InputFieldInputType;
526
- (function (InputFieldInputType) {
527
- InputFieldInputType["UNKNOWN_INPUT_TYPE"] = "UNKNOWN_INPUT_TYPE";
528
- InputFieldInputType["STRING"] = "STRING";
529
- InputFieldInputType["NUMBER"] = "NUMBER";
530
- InputFieldInputType["BOOLEAN"] = "BOOLEAN";
531
- InputFieldInputType["ARRAY"] = "ARRAY";
532
- InputFieldInputType["OBJECT"] = "OBJECT";
533
- InputFieldInputType["WIX_FILE"] = "WIX_FILE";
534
- InputFieldInputType["PAYMENT"] = "PAYMENT";
535
- InputFieldInputType["MULTILINE_ADDRESS"] = "MULTILINE_ADDRESS";
536
- InputFieldInputType["SCHEDULING"] = "SCHEDULING";
537
- })(InputFieldInputType || (InputFieldInputType = {}));
538
- export var FormFieldContactInfoEmailInfoTag;
539
- (function (FormFieldContactInfoEmailInfoTag) {
540
- FormFieldContactInfoEmailInfoTag["UNTAGGED"] = "UNTAGGED";
541
- FormFieldContactInfoEmailInfoTag["MAIN"] = "MAIN";
542
- })(FormFieldContactInfoEmailInfoTag || (FormFieldContactInfoEmailInfoTag = {}));
543
- export var FormFieldContactInfoPhoneInfoTag;
544
- (function (FormFieldContactInfoPhoneInfoTag) {
545
- FormFieldContactInfoPhoneInfoTag["UNTAGGED"] = "UNTAGGED";
546
- FormFieldContactInfoPhoneInfoTag["MAIN"] = "MAIN";
547
- })(FormFieldContactInfoPhoneInfoTag || (FormFieldContactInfoPhoneInfoTag = {}));
548
- export var AddressInfoTag;
549
- (function (AddressInfoTag) {
550
- AddressInfoTag["UNTAGGED"] = "UNTAGGED";
551
- AddressInfoTag["HOME"] = "HOME";
552
- })(AddressInfoTag || (AddressInfoTag = {}));
553
- export var SubscriptionInfoOptInLevel;
554
- (function (SubscriptionInfoOptInLevel) {
555
- SubscriptionInfoOptInLevel["UNKNOWN"] = "UNKNOWN";
556
- SubscriptionInfoOptInLevel["SINGLE_CONFIRMATION"] = "SINGLE_CONFIRMATION";
557
- SubscriptionInfoOptInLevel["DOUBLE_CONFIRMATION"] = "DOUBLE_CONFIRMATION";
558
- })(SubscriptionInfoOptInLevel || (SubscriptionInfoOptInLevel = {}));
559
- export var FormFieldContactInfoContactField;
560
- (function (FormFieldContactInfoContactField) {
561
- FormFieldContactInfoContactField["UNDEFINED"] = "UNDEFINED";
562
- FormFieldContactInfoContactField["FIRST_NAME"] = "FIRST_NAME";
563
- FormFieldContactInfoContactField["LAST_NAME"] = "LAST_NAME";
564
- FormFieldContactInfoContactField["COMPANY"] = "COMPANY";
565
- FormFieldContactInfoContactField["POSITION"] = "POSITION";
566
- FormFieldContactInfoContactField["EMAIL"] = "EMAIL";
567
- FormFieldContactInfoContactField["PHONE"] = "PHONE";
568
- FormFieldContactInfoContactField["ADDRESS"] = "ADDRESS";
569
- FormFieldContactInfoContactField["BIRTHDATE"] = "BIRTHDATE";
570
- FormFieldContactInfoContactField["CUSTOM_FIELD"] = "CUSTOM_FIELD";
571
- FormFieldContactInfoContactField["SUBSCRIPTION"] = "SUBSCRIPTION";
572
- FormFieldContactInfoContactField["VAT_ID"] = "VAT_ID";
573
- })(FormFieldContactInfoContactField || (FormFieldContactInfoContactField = {}));
574
- export var FormFieldV2FieldType;
575
- (function (FormFieldV2FieldType) {
576
- FormFieldV2FieldType["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
577
- FormFieldV2FieldType["INPUT"] = "INPUT";
578
- FormFieldV2FieldType["DISPLAY"] = "DISPLAY";
579
- })(FormFieldV2FieldType || (FormFieldV2FieldType = {}));
580
- export var DisplayFieldType;
581
- (function (DisplayFieldType) {
582
- DisplayFieldType["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
583
- DisplayFieldType["RICH_CONTENT"] = "RICH_CONTENT";
584
- DisplayFieldType["PAGE_NAVIGATION"] = "PAGE_NAVIGATION";
585
- })(DisplayFieldType || (DisplayFieldType = {}));
586
- export var FieldType;
587
- (function (FieldType) {
588
- FieldType["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
589
- FieldType["INPUT"] = "INPUT";
590
- FieldType["DISPLAY"] = "DISPLAY";
591
- })(FieldType || (FieldType = {}));
592
- export var FormatEnumFormat;
593
- (function (FormatEnumFormat) {
594
- FormatEnumFormat["UNKNOWN_FORMAT"] = "UNKNOWN_FORMAT";
595
- FormatEnumFormat["DATE"] = "DATE";
596
- FormatEnumFormat["TIME"] = "TIME";
597
- FormatEnumFormat["DATE_TIME"] = "DATE_TIME";
598
- FormatEnumFormat["EMAIL"] = "EMAIL";
599
- FormatEnumFormat["URL"] = "URL";
600
- FormatEnumFormat["UUID"] = "UUID";
601
- FormatEnumFormat["PHONE"] = "PHONE";
602
- FormatEnumFormat["URI"] = "URI";
603
- FormatEnumFormat["HOSTNAME"] = "HOSTNAME";
604
- FormatEnumFormat["COLOR_HEX"] = "COLOR_HEX";
605
- FormatEnumFormat["CURRENCY"] = "CURRENCY";
606
- FormatEnumFormat["LANGUAGE"] = "LANGUAGE";
607
- FormatEnumFormat["DATE_OPTIONAL_TIME"] = "DATE_OPTIONAL_TIME";
608
- })(FormatEnumFormat || (FormatEnumFormat = {}));
609
- export var StringComponentType;
610
- (function (StringComponentType) {
611
- StringComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
612
- StringComponentType["TEXT_INPUT"] = "TEXT_INPUT";
613
- StringComponentType["RADIO_GROUP"] = "RADIO_GROUP";
614
- StringComponentType["DROPDOWN"] = "DROPDOWN";
615
- StringComponentType["DATE_TIME"] = "DATE_TIME";
616
- StringComponentType["PHONE_INPUT"] = "PHONE_INPUT";
617
- StringComponentType["DATE_INPUT"] = "DATE_INPUT";
618
- StringComponentType["TIME_INPUT"] = "TIME_INPUT";
619
- StringComponentType["DATE_PICKER"] = "DATE_PICKER";
620
- })(StringComponentType || (StringComponentType = {}));
621
- export var NumberComponentType;
622
- (function (NumberComponentType) {
623
- NumberComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
624
- NumberComponentType["NUMBER_INPUT"] = "NUMBER_INPUT";
625
- NumberComponentType["RATING_INPUT"] = "RATING_INPUT";
626
- })(NumberComponentType || (NumberComponentType = {}));
627
- export var BooleanComponentType;
628
- (function (BooleanComponentType) {
629
- BooleanComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
630
- BooleanComponentType["CHECKBOX"] = "CHECKBOX";
631
- })(BooleanComponentType || (BooleanComponentType = {}));
632
- export var ItemType;
633
- (function (ItemType) {
634
- ItemType["UNKNOWN_ITEM_TYPE"] = "UNKNOWN_ITEM_TYPE";
635
- ItemType["STRING"] = "STRING";
636
- ItemType["NUMBER"] = "NUMBER";
637
- ItemType["BOOLEAN"] = "BOOLEAN";
638
- ItemType["INTEGER"] = "INTEGER";
639
- ItemType["OBJECT"] = "OBJECT";
640
- })(ItemType || (ItemType = {}));
641
- export var PropertiesTypeEnum;
642
- (function (PropertiesTypeEnum) {
643
- PropertiesTypeEnum["UNKNOWN_PROPERTY_TYPE"] = "UNKNOWN_PROPERTY_TYPE";
644
- PropertiesTypeEnum["STRING"] = "STRING";
645
- PropertiesTypeEnum["NUMBER"] = "NUMBER";
646
- PropertiesTypeEnum["BOOLEAN"] = "BOOLEAN";
647
- PropertiesTypeEnum["INTEGER"] = "INTEGER";
648
- PropertiesTypeEnum["ARRAY"] = "ARRAY";
649
- })(PropertiesTypeEnum || (PropertiesTypeEnum = {}));
650
- export var ComponentType;
651
- (function (ComponentType) {
652
- ComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
653
- ComponentType["CHECKBOX_GROUP"] = "CHECKBOX_GROUP";
654
- ComponentType["TAGS"] = "TAGS";
655
- })(ComponentType || (ComponentType = {}));
656
- export var WixFileComponentType;
657
- (function (WixFileComponentType) {
658
- WixFileComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
659
- WixFileComponentType["FILE_UPLOAD"] = "FILE_UPLOAD";
660
- WixFileComponentType["SIGNATURE"] = "SIGNATURE";
661
- })(WixFileComponentType || (WixFileComponentType = {}));
662
- export var PaymentComponentType;
663
- (function (PaymentComponentType) {
664
- PaymentComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
665
- PaymentComponentType["CHECKBOX_GROUP"] = "CHECKBOX_GROUP";
666
- PaymentComponentType["DONATION_INPUT"] = "DONATION_INPUT";
667
- PaymentComponentType["PAYMENT_INPUT"] = "PAYMENT_INPUT";
668
- PaymentComponentType["FIXED_PAYMENT"] = "FIXED_PAYMENT";
669
- })(PaymentComponentType || (PaymentComponentType = {}));
670
- export var MultilineAddressComponentType;
671
- (function (MultilineAddressComponentType) {
672
- MultilineAddressComponentType["UNKNOWN_COMPONENT_TYPE"] = "UNKNOWN_COMPONENT_TYPE";
673
- MultilineAddressComponentType["MULTILINE_ADDRESS"] = "MULTILINE_ADDRESS";
674
- })(MultilineAddressComponentType || (MultilineAddressComponentType = {}));
675
- export var InputType;
676
- (function (InputType) {
677
- InputType["UNKNOWN_INPUT_TYPE"] = "UNKNOWN_INPUT_TYPE";
678
- InputType["STRING"] = "STRING";
679
- InputType["NUMBER"] = "NUMBER";
680
- InputType["BOOLEAN"] = "BOOLEAN";
681
- InputType["ARRAY"] = "ARRAY";
682
- InputType["OBJECT"] = "OBJECT";
683
- InputType["WIX_FILE"] = "WIX_FILE";
684
- InputType["PAYMENT"] = "PAYMENT";
685
- InputType["MULTILINE_ADDRESS"] = "MULTILINE_ADDRESS";
686
- })(InputType || (InputType = {}));
687
- export var EmailInfoTag;
688
- (function (EmailInfoTag) {
689
- EmailInfoTag["UNTAGGED"] = "UNTAGGED";
690
- EmailInfoTag["MAIN"] = "MAIN";
691
- })(EmailInfoTag || (EmailInfoTag = {}));
692
- export var PhoneInfoTag;
693
- (function (PhoneInfoTag) {
694
- PhoneInfoTag["UNTAGGED"] = "UNTAGGED";
695
- PhoneInfoTag["MAIN"] = "MAIN";
696
- })(PhoneInfoTag || (PhoneInfoTag = {}));
697
- export var Tag;
698
- (function (Tag) {
699
- Tag["UNTAGGED"] = "UNTAGGED";
700
- Tag["HOME"] = "HOME";
701
- })(Tag || (Tag = {}));
702
- export var ConfirmationLevel;
703
- (function (ConfirmationLevel) {
704
- ConfirmationLevel["UNKNOWN_CONFIRMATION_LEVEL"] = "UNKNOWN_CONFIRMATION_LEVEL";
705
- ConfirmationLevel["SINGLE_CONFIRMATION"] = "SINGLE_CONFIRMATION";
706
- ConfirmationLevel["DOUBLE_CONFIRMATION"] = "DOUBLE_CONFIRMATION";
707
- })(ConfirmationLevel || (ConfirmationLevel = {}));
708
- export var ContactField;
709
- (function (ContactField) {
710
- ContactField["UNKNOWN_CONTACT_FIELD"] = "UNKNOWN_CONTACT_FIELD";
711
- ContactField["FIRST_NAME"] = "FIRST_NAME";
712
- ContactField["LAST_NAME"] = "LAST_NAME";
713
- ContactField["COMPANY"] = "COMPANY";
714
- ContactField["POSITION"] = "POSITION";
715
- ContactField["EMAIL"] = "EMAIL";
716
- ContactField["PHONE"] = "PHONE";
717
- ContactField["ADDRESS"] = "ADDRESS";
718
- ContactField["BIRTHDATE"] = "BIRTHDATE";
719
- ContactField["CUSTOM_FIELD"] = "CUSTOM_FIELD";
720
- ContactField["SUBSCRIPTION"] = "SUBSCRIPTION";
721
- ContactField["VAT_ID"] = "VAT_ID";
722
- })(ContactField || (ContactField = {}));
723
- export var DisplayFieldDisplayFieldType;
724
- (function (DisplayFieldDisplayFieldType) {
725
- DisplayFieldDisplayFieldType["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
726
- DisplayFieldDisplayFieldType["RICH_CONTENT"] = "RICH_CONTENT";
727
- DisplayFieldDisplayFieldType["PAGE_NAVIGATION"] = "PAGE_NAVIGATION";
728
- DisplayFieldDisplayFieldType["LOGIN_BAR"] = "LOGIN_BAR";
729
- })(DisplayFieldDisplayFieldType || (DisplayFieldDisplayFieldType = {}));
730
- export var OverrideEntityType;
731
- (function (OverrideEntityType) {
732
- OverrideEntityType["UNKNOWN"] = "UNKNOWN";
733
- OverrideEntityType["FIELD"] = "FIELD";
734
- })(OverrideEntityType || (OverrideEntityType = {}));
735
- export var Kind;
736
- (function (Kind) {
737
- /** Return forms specific to tenant, excluding template based forms. */
738
- Kind["REGULAR"] = "REGULAR";
739
- /** Return forms based on common templates, with applied user overrides if they exist. */
740
- Kind["EXTENSION"] = "EXTENSION";
741
- })(Kind || (Kind = {}));
742
- export var SpamFilterProtectionLevel;
743
- (function (SpamFilterProtectionLevel) {
744
- /** Unknown spam filter protection level. */
745
- SpamFilterProtectionLevel["UNKNOWN"] = "UNKNOWN";
746
- /** Spam filter is not used. Form is open for spam submissions. */
747
- SpamFilterProtectionLevel["NONE"] = "NONE";
748
- /** Spam filter operates in basic mode. Form is open to high risk of spam submissions. */
749
- SpamFilterProtectionLevel["BASIC"] = "BASIC";
750
- /** Spam filter operates in advanced mode. Form is open to low risk of spam submissions. */
751
- SpamFilterProtectionLevel["ADVANCED"] = "ADVANCED";
752
- })(SpamFilterProtectionLevel || (SpamFilterProtectionLevel = {}));
753
- export var RequiredIndicator;
754
- (function (RequiredIndicator) {
755
- /** Unknown required indicator. */
756
- RequiredIndicator["UNKNOWN_INDICATOR"] = "UNKNOWN_INDICATOR";
757
- /** Asterisk (*). */
758
- RequiredIndicator["ASTERISK"] = "ASTERISK";
759
- /** Text (default: "Required"). */
760
- RequiredIndicator["TEXT"] = "TEXT";
761
- /** None. */
762
- RequiredIndicator["NONE"] = "NONE";
763
- })(RequiredIndicator || (RequiredIndicator = {}));
764
- export var RequiredIndicatorPlacement;
765
- (function (RequiredIndicatorPlacement) {
766
- /** Unknown required indicator placement. */
767
- RequiredIndicatorPlacement["UNKNOWN_PLACEMENT"] = "UNKNOWN_PLACEMENT";
768
- /** After field title. */
769
- RequiredIndicatorPlacement["AFTER_FIELD_TITLE"] = "AFTER_FIELD_TITLE";
770
- /** Before field title. */
771
- RequiredIndicatorPlacement["BEFORE_FIELD_TITLE"] = "BEFORE_FIELD_TITLE";
772
- })(RequiredIndicatorPlacement || (RequiredIndicatorPlacement = {}));
773
- export var Target;
774
- (function (Target) {
775
- /** Unknown target. */
776
- Target["UNKNOWN_TARGET"] = "UNKNOWN_TARGET";
777
- /** Open in the same browser tab. */
778
- Target["SELF"] = "SELF";
779
- /** Open in a new browser tab. */
780
- Target["BLANK"] = "BLANK";
781
- })(Target || (Target = {}));
782
- export var SubmitSuccessAction;
783
- (function (SubmitSuccessAction) {
784
- /** Unknown submit success action. */
785
- SubmitSuccessAction["UNKNOWN_SUBMIT_SUCCESS_ACTION"] = "UNKNOWN_SUBMIT_SUCCESS_ACTION";
786
- /** No action will be taken after submission. */
787
- SubmitSuccessAction["NO_ACTION"] = "NO_ACTION";
788
- /** A thank you message will be shown after submission. */
789
- SubmitSuccessAction["THANK_YOU_MESSAGE"] = "THANK_YOU_MESSAGE";
790
- /** The user will be redirected to a URL after submission. */
791
- SubmitSuccessAction["REDIRECT"] = "REDIRECT";
792
- })(SubmitSuccessAction || (SubmitSuccessAction = {}));
793
- /** Enum for different types of changeable properties. */
794
- export var ChangeableProperty;
795
- (function (ChangeableProperty) {
796
- /** Unknown property type. */
797
- ChangeableProperty["UNKNOWN_CHANGEABLE_PROPERTY"] = "UNKNOWN_CHANGEABLE_PROPERTY";
798
- /** Required property type. */
799
- ChangeableProperty["REQUIRED"] = "REQUIRED";
800
- /** Hidden property type. */
801
- ChangeableProperty["HIDDEN"] = "HIDDEN";
802
- /** Allowed values property type. */
803
- ChangeableProperty["ALLOWED_VALUES"] = "ALLOWED_VALUES";
804
- })(ChangeableProperty || (ChangeableProperty = {}));
805
- export var OverrideEntityTypeEnumOverrideEntityType;
806
- (function (OverrideEntityTypeEnumOverrideEntityType) {
807
- OverrideEntityTypeEnumOverrideEntityType["UNKNOWN_OVERRIDE_ENTITY_TYPE"] = "UNKNOWN_OVERRIDE_ENTITY_TYPE";
808
- OverrideEntityTypeEnumOverrideEntityType["FIELD"] = "FIELD";
809
- })(OverrideEntityTypeEnumOverrideEntityType || (OverrideEntityTypeEnumOverrideEntityType = {}));
810
- export var Operator;
811
- (function (Operator) {
812
- Operator["UNKNOWN_OPERATOR"] = "UNKNOWN_OPERATOR";
813
- Operator["EQUAL"] = "EQUAL";
814
- Operator["NOT_EQUAL"] = "NOT_EQUAL";
815
- Operator["EMPTY"] = "EMPTY";
816
- Operator["NOT_EMPTY"] = "NOT_EMPTY";
817
- Operator["CONTAINS"] = "CONTAINS";
818
- Operator["NOT_CONTAINS"] = "NOT_CONTAINS";
819
- Operator["LESS_THAN"] = "LESS_THAN";
820
- Operator["LESS_THAN_OR_EQUALS"] = "LESS_THAN_OR_EQUALS";
821
- Operator["GREATER_THAN"] = "GREATER_THAN";
822
- Operator["GREATER_THAN_OR_EQUALS"] = "GREATER_THAN_OR_EQUALS";
823
- Operator["BEFORE"] = "BEFORE";
824
- Operator["BEFORE_OR_EQUAL"] = "BEFORE_OR_EQUAL";
825
- Operator["AFTER"] = "AFTER";
826
- Operator["AFTER_OR_EQUAL"] = "AFTER_OR_EQUAL";
827
- Operator["BETWEEN"] = "BETWEEN";
828
- Operator["ANY"] = "ANY";
829
- Operator["ARRAY_EQUAL"] = "ARRAY_EQUAL";
830
- Operator["ARRAY_NOT_EQUAL"] = "ARRAY_NOT_EQUAL";
831
- Operator["CHECKED"] = "CHECKED";
832
- Operator["NOT_CHECKED"] = "NOT_CHECKED";
833
- Operator["IN"] = "IN";
834
- Operator["NOT_IN"] = "NOT_IN";
835
- Operator["IS_DATE_OLDER_THAN"] = "IS_DATE_OLDER_THAN";
836
- Operator["IS_DATE_OLDER_THAN_OR_EQUAL"] = "IS_DATE_OLDER_THAN_OR_EQUAL";
837
- Operator["IS_DATE_NEWER_THAN"] = "IS_DATE_NEWER_THAN";
838
- Operator["IS_DATE_NEWER_THAN_OR_EQUAL"] = "IS_DATE_NEWER_THAN_OR_EQUAL";
839
- })(Operator || (Operator = {}));
840
- export var WebhookIdentityType;
841
- (function (WebhookIdentityType) {
842
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
843
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
844
- WebhookIdentityType["MEMBER"] = "MEMBER";
845
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
846
- WebhookIdentityType["APP"] = "APP";
847
- })(WebhookIdentityType || (WebhookIdentityType = {}));
848
- export var IdentityType;
849
- (function (IdentityType) {
850
- IdentityType["UNKNOWN"] = "UNKNOWN";
851
- /** Existing or new contact */
852
- IdentityType["CONTACT"] = "CONTACT";
853
- /** Member is logged in, matching logic skipped */
854
- IdentityType["MEMBER"] = "MEMBER";
855
- /** Matching contact is a member, Merge logic won't be applied */
856
- IdentityType["NOT_AUTHENTICATED_MEMBER"] = "NOT_AUTHENTICATED_MEMBER";
857
- })(IdentityType || (IdentityType = {}));
858
- export var ErrorType;
859
- (function (ErrorType) {
860
- /** Error is unknown or not suitable for any of options bellow */
861
- ErrorType["UNKNOWN_ERROR"] = "UNKNOWN_ERROR";
862
- /** Type of submitted value is incorrect */
863
- ErrorType["TYPE_ERROR"] = "TYPE_ERROR";
864
- /** Value is required to be provided */
865
- ErrorType["REQUIRED_VALUE_ERROR"] = "REQUIRED_VALUE_ERROR";
866
- /** Value contains additional properties not expected in schema */
867
- ErrorType["UNKNOWN_VALUE_ERROR"] = "UNKNOWN_VALUE_ERROR";
868
- /** Text value exceeds max length */
869
- ErrorType["MAX_LENGTH_ERROR"] = "MAX_LENGTH_ERROR";
870
- /** Text value not reaches min length */
871
- ErrorType["MIN_LENGTH_ERROR"] = "MIN_LENGTH_ERROR";
872
- /** Text value not applicable for expected pattern */
873
- ErrorType["PATTERN_ERROR"] = "PATTERN_ERROR";
874
- /** Text value not applicable for expected format */
875
- ErrorType["FORMAT_ERROR"] = "FORMAT_ERROR";
876
- /** Number value is too big */
877
- ErrorType["MAX_VALUE_ERROR"] = "MAX_VALUE_ERROR";
878
- /** Number value is too small */
879
- ErrorType["MIN_VALUE_ERROR"] = "MIN_VALUE_ERROR";
880
- /** Number value is not multiple of expected number */
881
- ErrorType["MULTIPLE_OF_VALUE_ERROR"] = "MULTIPLE_OF_VALUE_ERROR";
882
- /** Array value has too much items */
883
- ErrorType["MIN_ITEMS_ERROR"] = "MIN_ITEMS_ERROR";
884
- /** Array value has not enough items */
885
- ErrorType["MAX_ITEMS_ERROR"] = "MAX_ITEMS_ERROR";
886
- /** Value is not in list of allowed values */
887
- ErrorType["NOT_ALLOWED_VALUE_ERROR"] = "NOT_ALLOWED_VALUE_ERROR";
888
- /** Form fields are incompatible */
889
- ErrorType["FIELDS_COMPATIBILITY_ERROR"] = "FIELDS_COMPATIBILITY_ERROR";
890
- /** Submitted form is disabled */
891
- ErrorType["DISABLED_FORM_ERROR"] = "DISABLED_FORM_ERROR";
892
- /** Too much forms */
893
- ErrorType["FORMS_COUNT_RESTRICTIONS_ERROR"] = "FORMS_COUNT_RESTRICTIONS_ERROR";
894
- /** Too much fields on form */
895
- ErrorType["FIELDS_COUNT_RESTRICTIONS_ERROR"] = "FIELDS_COUNT_RESTRICTIONS_ERROR";
896
- /** Too much steps on forms */
897
- ErrorType["STEPS_COUNT_RESTRICTIONS_ERROR"] = "STEPS_COUNT_RESTRICTIONS_ERROR";
898
- /** Too much rules on forms */
899
- ErrorType["RULES_COUNT_RESTRICTIONS_ERROR"] = "RULES_COUNT_RESTRICTIONS_ERROR";
900
- /** File upload is not allowed */
901
- ErrorType["FILE_UPLOAD_RESTRICTIONS_ERROR"] = "FILE_UPLOAD_RESTRICTIONS_ERROR";
902
- /** Country code is not correct or missing from the phone number */
903
- ErrorType["INVALID_PHONE_COUNTRY_CODE_ERROR"] = "INVALID_PHONE_COUNTRY_CODE_ERROR";
904
- /** Invalid staff member ID on appointment */
905
- ErrorType["INVALID_STAFF_ID_ERROR"] = "INVALID_STAFF_ID_ERROR";
906
- /** Invalid business location ID on appointment */
907
- ErrorType["INVALID_LOCATION_ID_ERROR"] = "INVALID_LOCATION_ID_ERROR";
908
- })(ErrorType || (ErrorType = {}));
909
- export var SortOrder;
910
- (function (SortOrder) {
911
- SortOrder["ASC"] = "ASC";
912
- SortOrder["DESC"] = "DESC";
913
- })(SortOrder || (SortOrder = {}));
914
- export var Mode;
915
- (function (Mode) {
916
- /** Any of the search terms must be present */
917
- Mode["OR"] = "OR";
918
- /** All search terms must be present */
919
- Mode["AND"] = "AND";
920
- })(Mode || (Mode = {}));
921
- export var Status;
922
- (function (Status) {
923
- Status["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
924
- Status["READY"] = "READY";
925
- Status["PENDING"] = "PENDING";
926
- Status["FAILED"] = "FAILED";
927
- })(Status || (Status = {}));
928
- export var SubmissionErrorType;
929
- (function (SubmissionErrorType) {
930
- /** Error is unknown or unsuitable for any of the options below. */
931
- SubmissionErrorType["UNKNOWN_ERROR"] = "UNKNOWN_ERROR";
932
- /** Type of submitted value is incorrect. */
933
- SubmissionErrorType["TYPE_ERROR"] = "TYPE_ERROR";
934
- /** Value is required to be provided. */
935
- SubmissionErrorType["REQUIRED_VALUE_ERROR"] = "REQUIRED_VALUE_ERROR";
936
- /** Value contains additional properties not expected in schema. */
937
- SubmissionErrorType["UNKNOWN_VALUE_ERROR"] = "UNKNOWN_VALUE_ERROR";
938
- /** Text value exceeds max length. */
939
- SubmissionErrorType["MAX_LENGTH_ERROR"] = "MAX_LENGTH_ERROR";
940
- /** Text value does not reach min length. */
941
- SubmissionErrorType["MIN_LENGTH_ERROR"] = "MIN_LENGTH_ERROR";
942
- /** Text value is not applicable for expected pattern. */
943
- SubmissionErrorType["PATTERN_ERROR"] = "PATTERN_ERROR";
944
- /** Text value is not applicable for expected format. */
945
- SubmissionErrorType["FORMAT_ERROR"] = "FORMAT_ERROR";
946
- /** Number value is too big. */
947
- SubmissionErrorType["MAX_VALUE_ERROR"] = "MAX_VALUE_ERROR";
948
- /** Number value is too small. */
949
- SubmissionErrorType["MIN_VALUE_ERROR"] = "MIN_VALUE_ERROR";
950
- /** Number value is not a multiple of expected number. */
951
- SubmissionErrorType["MULTIPLE_OF_VALUE_ERROR"] = "MULTIPLE_OF_VALUE_ERROR";
952
- /** Array value has too many items. */
953
- SubmissionErrorType["MIN_ITEMS_ERROR"] = "MIN_ITEMS_ERROR";
954
- /** Array value has not enough items. */
955
- SubmissionErrorType["MAX_ITEMS_ERROR"] = "MAX_ITEMS_ERROR";
956
- /** Value is not in the list of allowed values. */
957
- SubmissionErrorType["NOT_ALLOWED_VALUE_ERROR"] = "NOT_ALLOWED_VALUE_ERROR";
958
- /** Submitted form is disabled. */
959
- SubmissionErrorType["DISABLED_FORM_ERROR"] = "DISABLED_FORM_ERROR";
960
- })(SubmissionErrorType || (SubmissionErrorType = {}));
961
- /**
962
- * Upserts contact from submission.
963
- * @param submissionId - Submission from which contact needs to be upserted.
964
- * @public
965
- * @documentationMaturity preview
966
- * @requiredField submissionId
967
- * @permissionId WIX_FORMS.SUBMISSION_CONTACT_UPSERT
968
- * @permissionScope Manage form submissions.
969
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
970
- * @applicableIdentity APP
971
- * @fqn wix.forms.v4.FormSubmissionContactUpsertService.UpsertContactFromSubmission
972
- */
973
- export async function upsertContactFromSubmission(submissionId, options) {
974
- // @ts-ignore
975
- const { httpClient, sideEffects } = arguments[2];
976
- const payload = renameKeysFromSDKRequestToRESTRequest({
977
- submissionId: submissionId,
978
- contactId: options?.contactId,
979
- emailVerified: options?.emailVerified,
980
- });
981
- const reqOpts = ambassadorWixFormsV4Submission.upsertContactFromSubmission(payload);
982
- sideEffects?.onSiteCall?.();
983
- try {
984
- const result = await httpClient.request(reqOpts);
985
- sideEffects?.onSuccess?.(result);
986
- return renameKeysFromRESTResponseToSDKResponse(result.data);
987
- }
988
- catch (err) {
989
- const transformedError = sdkTransformError(err, {
990
- spreadPathsToArguments: {},
991
- explicitPathsToArguments: {
992
- submissionId: '$[0]',
993
- contactId: '$[1].contactId',
994
- emailVerified: '$[1].emailVerified',
995
- },
996
- singleArgumentUnchanged: false,
997
- }, ['submissionId', 'options']);
998
- sideEffects?.onError?.(err);
999
- throw transformedError;
1000
- }
1001
- }
1002
- /**
1003
- * Creates a submission.
1004
- *
1005
- *
1006
- * The `createSubmission()` function is an alternative way to the [`WixFormsV2`](https://www.wix.com/velo/reference/$w/wixformsv2/submit) element for submitting a form. In this case, clicking the submit button is unnecessary, the submission is automatically created when calling this function.
1007
- * @param submission - Submission to create.
1008
- * @public
1009
- * @requiredField submission
1010
- * @requiredField submission.formId
1011
- * @param options - Optional fields.
1012
- * @permissionId WIX_FORMS.SUBMISSION_CREATE
1013
- * @permissionScope Manage Submissions
1014
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1015
- * @permissionScope Manage form submissions.
1016
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1017
- * @permissionScope Manage Challenges
1018
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1019
- * @applicableIdentity APP
1020
- * @applicableIdentity VISITOR
1021
- * @returns The created submission.
1022
- * @fqn wix.forms.v4.FormSubmissionService.CreateSubmission
1023
- */
1024
- export async function createSubmission(submission, options) {
1025
- // @ts-ignore
1026
- const { httpClient, sideEffects } = arguments[2];
1027
- const payload = renameKeysFromSDKRequestToRESTRequest({
1028
- submission: submission,
1029
- captchaToken: options?.captchaToken,
1030
- });
1031
- const reqOpts = ambassadorWixFormsV4Submission.createSubmission(payload);
1032
- sideEffects?.onSiteCall?.();
1033
- try {
1034
- const result = await httpClient.request(reqOpts);
1035
- sideEffects?.onSuccess?.(result);
1036
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.submission;
1037
- }
1038
- catch (err) {
1039
- const transformedError = sdkTransformError(err, {
1040
- spreadPathsToArguments: {},
1041
- explicitPathsToArguments: {
1042
- submission: '$[0]',
1043
- captchaToken: '$[1].captchaToken',
1044
- },
1045
- singleArgumentUnchanged: false,
1046
- }, ['submission', 'options']);
1047
- sideEffects?.onError?.(err);
1048
- throw transformedError;
1049
- }
1050
- }
1051
- /**
1052
- * Retrieves a submission by ID.
1053
- * @param submissionId - ID of the submission to retrieve.
1054
- * @public
1055
- * @requiredField submissionId
1056
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1057
- * @permissionScope Manage Submissions
1058
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1059
- * @permissionScope Manage Orders
1060
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1061
- * @permissionScope Manage form submissions.
1062
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1063
- * @permissionScope Read Orders
1064
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1065
- * @permissionScope Read Submissions
1066
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1067
- * @applicableIdentity APP
1068
- * @returns The retrieved submission.
1069
- * @fqn wix.forms.v4.FormSubmissionService.GetSubmission
1070
- */
1071
- export async function getSubmission(submissionId) {
1072
- // @ts-ignore
1073
- const { httpClient, sideEffects } = arguments[1];
1074
- const payload = renameKeysFromSDKRequestToRESTRequest({
1075
- submissionId: submissionId,
1076
- });
1077
- const reqOpts = ambassadorWixFormsV4Submission.getSubmission(payload);
1078
- sideEffects?.onSiteCall?.();
1079
- try {
1080
- const result = await httpClient.request(reqOpts);
1081
- sideEffects?.onSuccess?.(result);
1082
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.submission;
1083
- }
1084
- catch (err) {
1085
- const transformedError = sdkTransformError(err, {
1086
- spreadPathsToArguments: {},
1087
- explicitPathsToArguments: { submissionId: '$[0]' },
1088
- singleArgumentUnchanged: false,
1089
- }, ['submissionId']);
1090
- sideEffects?.onError?.(err);
1091
- throw transformedError;
1092
- }
1093
- }
1094
- /**
1095
- * Updates a submission.
1096
- *
1097
- *
1098
- * Each time the submission is updated, `revision` increments by 1. The existing `revision` must be included when updating the submission. This ensures you're working with the latest submission information, and prevents unintended overwrites.
1099
- * @param _id - Submission ID.
1100
- * @public
1101
- * @requiredField _id
1102
- * @requiredField submission
1103
- * @requiredField submission.formId
1104
- * @requiredField submission.revision
1105
- * @param submission - Submission to update.
1106
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
1107
- * @permissionScope Manage Submissions
1108
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1109
- * @permissionScope Manage form submissions.
1110
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1111
- * @applicableIdentity APP
1112
- * @returns The updated submission.
1113
- * @fqn wix.forms.v4.FormSubmissionService.UpdateSubmission
1114
- */
1115
- export async function updateSubmission(_id, submission) {
1116
- // @ts-ignore
1117
- const { httpClient, sideEffects } = arguments[2];
1118
- const payload = renameKeysFromSDKRequestToRESTRequest({
1119
- submission: { ...submission, id: _id },
1120
- });
1121
- const reqOpts = ambassadorWixFormsV4Submission.updateSubmission(payload);
1122
- sideEffects?.onSiteCall?.();
1123
- try {
1124
- const result = await httpClient.request(reqOpts);
1125
- sideEffects?.onSuccess?.(result);
1126
- return renameKeysFromRESTResponseToSDKResponse(result.data)?.submission;
1127
- }
1128
- catch (err) {
1129
- const transformedError = sdkTransformError(err, {
1130
- spreadPathsToArguments: { submission: '$[1]' },
1131
- explicitPathsToArguments: { 'submission.id': '$[0]' },
1132
- singleArgumentUnchanged: false,
1133
- }, ['_id', 'submission']);
1134
- sideEffects?.onError?.(err);
1135
- throw transformedError;
1136
- }
1137
- }
1138
- /**
1139
- * Confirms a submission.
1140
- *
1141
- *
1142
- * You can only confirm a submission that has a `PENDING` status.
1143
- * When using forms from the [Wix Pricing Plans](https://www.wix.com/app-market/paid-plans?referral=collection&appIndex=42&referralTag=made-by-wix&referralSectionName=made-by-wix) app, the default submission status is `PENDING`.
1144
- * When using forms from the [Wix Forms]() app, the default form submission status is `CONFIRMED`. You can change the default status for individual submissions using the `updateSubmission()` method.
1145
- * @param submissionId - Submission ID to confirm.
1146
- * @public
1147
- * @requiredField submissionId
1148
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
1149
- * @permissionScope Manage Submissions
1150
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1151
- * @permissionScope Manage form submissions.
1152
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1153
- * @applicableIdentity APP
1154
- * @fqn wix.forms.v4.FormSubmissionService.ConfirmSubmission
1155
- */
1156
- export async function confirmSubmission(submissionId) {
1157
- // @ts-ignore
1158
- const { httpClient, sideEffects } = arguments[1];
1159
- const payload = renameKeysFromSDKRequestToRESTRequest({
1160
- submissionId: submissionId,
1161
- });
1162
- const reqOpts = ambassadorWixFormsV4Submission.confirmSubmission(payload);
1163
- sideEffects?.onSiteCall?.();
1164
- try {
1165
- const result = await httpClient.request(reqOpts);
1166
- sideEffects?.onSuccess?.(result);
1167
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1168
- }
1169
- catch (err) {
1170
- const transformedError = sdkTransformError(err, {
1171
- spreadPathsToArguments: {},
1172
- explicitPathsToArguments: { submissionId: '$[0]' },
1173
- singleArgumentUnchanged: false,
1174
- }, ['submissionId']);
1175
- sideEffects?.onError?.(err);
1176
- throw transformedError;
1177
- }
1178
- }
1179
- /**
1180
- * Deletes a submission.
1181
- *
1182
- *
1183
- * This function moves the form submission into the trash bin. To delete the submission permanently, change the default `permanent` field value to `true.`
1184
- * @param submissionId - ID of the submission to delete.
1185
- * @public
1186
- * @requiredField submissionId
1187
- * @param options - Optional fields.
1188
- * @permissionId WIX_FORMS.SUBMISSION_DELETE
1189
- * @permissionScope Manage Submissions
1190
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1191
- * @permissionScope Manage form submissions.
1192
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1193
- * @applicableIdentity APP
1194
- * @fqn wix.forms.v4.FormSubmissionService.DeleteSubmission
1195
- */
1196
- export async function deleteSubmission(submissionId, options) {
1197
- // @ts-ignore
1198
- const { httpClient, sideEffects } = arguments[2];
1199
- const payload = renameKeysFromSDKRequestToRESTRequest({
1200
- submissionId: submissionId,
1201
- permanent: options?.permanent,
1202
- preserveFiles: options?.preserveFiles,
1203
- });
1204
- const reqOpts = ambassadorWixFormsV4Submission.deleteSubmission(payload);
1205
- sideEffects?.onSiteCall?.();
1206
- try {
1207
- const result = await httpClient.request(reqOpts);
1208
- sideEffects?.onSuccess?.(result);
1209
- }
1210
- catch (err) {
1211
- const transformedError = sdkTransformError(err, {
1212
- spreadPathsToArguments: {},
1213
- explicitPathsToArguments: {
1214
- submissionId: '$[0]',
1215
- permanent: '$[1].permanent',
1216
- preserveFiles: '$[1].preserveFiles',
1217
- },
1218
- singleArgumentUnchanged: false,
1219
- }, ['submissionId', 'options']);
1220
- sideEffects?.onError?.(err);
1221
- throw transformedError;
1222
- }
1223
- }
1224
- /**
1225
- * Deletes submissions by IDS for specific form.
1226
- * @param formId - Form ID.
1227
- * @public
1228
- * @documentationMaturity preview
1229
- * @requiredField formId
1230
- * @permissionId WIX_FORMS.SUBMISSION_DELETE
1231
- * @permissionScope Manage Submissions
1232
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1233
- * @permissionScope Manage form submissions.
1234
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1235
- * @applicableIdentity APP
1236
- * @fqn wix.forms.v4.FormSubmissionService.BulkDeleteSubmission
1237
- */
1238
- export async function bulkDeleteSubmission(formId, options) {
1239
- // @ts-ignore
1240
- const { httpClient, sideEffects } = arguments[2];
1241
- const payload = renameKeysFromSDKRequestToRESTRequest({
1242
- formId: formId,
1243
- submissionIds: options?.submissionIds,
1244
- permanent: options?.permanent,
1245
- preserveFiles: options?.preserveFiles,
1246
- });
1247
- const reqOpts = ambassadorWixFormsV4Submission.bulkDeleteSubmission(payload);
1248
- sideEffects?.onSiteCall?.();
1249
- try {
1250
- const result = await httpClient.request(reqOpts);
1251
- sideEffects?.onSuccess?.(result);
1252
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1253
- }
1254
- catch (err) {
1255
- const transformedError = sdkTransformError(err, {
1256
- spreadPathsToArguments: {},
1257
- explicitPathsToArguments: {
1258
- formId: '$[0]',
1259
- submissionIds: '$[1].submissionIds',
1260
- permanent: '$[1].permanent',
1261
- preserveFiles: '$[1].preserveFiles',
1262
- },
1263
- singleArgumentUnchanged: false,
1264
- }, ['formId', 'options']);
1265
- sideEffects?.onError?.(err);
1266
- throw transformedError;
1267
- }
1268
- }
1269
- /**
1270
- * Restores deleted submission
1271
- * @param submissionId - ID of the submission to restore.
1272
- * @public
1273
- * @documentationMaturity preview
1274
- * @requiredField submissionId
1275
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
1276
- * @permissionScope Manage Submissions
1277
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1278
- * @permissionScope Manage form submissions.
1279
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1280
- * @applicableIdentity APP
1281
- * @fqn wix.forms.v4.FormSubmissionService.RestoreSubmissionFromTrashBin
1282
- */
1283
- export async function restoreSubmissionFromTrashBin(submissionId) {
1284
- // @ts-ignore
1285
- const { httpClient, sideEffects } = arguments[1];
1286
- const payload = renameKeysFromSDKRequestToRESTRequest({
1287
- submissionId: submissionId,
1288
- });
1289
- const reqOpts = ambassadorWixFormsV4Submission.restoreSubmissionFromTrashBin(payload);
1290
- sideEffects?.onSiteCall?.();
1291
- try {
1292
- const result = await httpClient.request(reqOpts);
1293
- sideEffects?.onSuccess?.(result);
1294
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1295
- }
1296
- catch (err) {
1297
- const transformedError = sdkTransformError(err, {
1298
- spreadPathsToArguments: {},
1299
- explicitPathsToArguments: { submissionId: '$[0]' },
1300
- singleArgumentUnchanged: false,
1301
- }, ['submissionId']);
1302
- sideEffects?.onError?.(err);
1303
- throw transformedError;
1304
- }
1305
- }
1306
- /**
1307
- * Remove deleted submission
1308
- * @param submissionId - ID of the submission to restore.
1309
- * @public
1310
- * @documentationMaturity preview
1311
- * @requiredField submissionId
1312
- * @permissionId WIX_FORMS.SUBMISSION_DELETE
1313
- * @permissionScope Manage Submissions
1314
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1315
- * @permissionScope Manage form submissions.
1316
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1317
- * @applicableIdentity APP
1318
- * @fqn wix.forms.v4.FormSubmissionService.RemoveSubmissionFromTrashBin
1319
- */
1320
- export async function removeSubmissionFromTrashBin(submissionId) {
1321
- // @ts-ignore
1322
- const { httpClient, sideEffects } = arguments[1];
1323
- const payload = renameKeysFromSDKRequestToRESTRequest({
1324
- submissionId: submissionId,
1325
- });
1326
- const reqOpts = ambassadorWixFormsV4Submission.removeSubmissionFromTrashBin(payload);
1327
- sideEffects?.onSiteCall?.();
1328
- try {
1329
- const result = await httpClient.request(reqOpts);
1330
- sideEffects?.onSuccess?.(result);
1331
- }
1332
- catch (err) {
1333
- const transformedError = sdkTransformError(err, {
1334
- spreadPathsToArguments: {},
1335
- explicitPathsToArguments: { submissionId: '$[0]' },
1336
- singleArgumentUnchanged: false,
1337
- }, ['submissionId']);
1338
- sideEffects?.onError?.(err);
1339
- throw transformedError;
1340
- }
1341
- }
1342
- /**
1343
- * Remove multiple deleted submissions
1344
- * @param formId - Form ID.
1345
- * @public
1346
- * @documentationMaturity preview
1347
- * @requiredField formId
1348
- * @permissionId WIX_FORMS.SUBMISSION_DELETE
1349
- * @permissionScope Manage Submissions
1350
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1351
- * @permissionScope Manage form submissions.
1352
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1353
- * @applicableIdentity APP
1354
- * @fqn wix.forms.v4.FormSubmissionService.BulkRemoveSubmissionFromTrashBin
1355
- */
1356
- export async function bulkRemoveSubmissionFromTrashBin(formId, options) {
1357
- // @ts-ignore
1358
- const { httpClient, sideEffects } = arguments[2];
1359
- const payload = renameKeysFromSDKRequestToRESTRequest({
1360
- formId: formId,
1361
- submissionIds: options?.submissionIds,
1362
- });
1363
- const reqOpts = ambassadorWixFormsV4Submission.bulkRemoveSubmissionFromTrashBin(payload);
1364
- sideEffects?.onSiteCall?.();
1365
- try {
1366
- const result = await httpClient.request(reqOpts);
1367
- sideEffects?.onSuccess?.(result);
1368
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1369
- }
1370
- catch (err) {
1371
- const transformedError = sdkTransformError(err, {
1372
- spreadPathsToArguments: {},
1373
- explicitPathsToArguments: {
1374
- formId: '$[0]',
1375
- submissionIds: '$[1].submissionIds',
1376
- },
1377
- singleArgumentUnchanged: false,
1378
- }, ['formId', 'options']);
1379
- sideEffects?.onError?.(err);
1380
- throw transformedError;
1381
- }
1382
- }
1383
- /**
1384
- * List deleted submissions
1385
- * @param formId - Form ID.
1386
- * @public
1387
- * @documentationMaturity preview
1388
- * @requiredField formId
1389
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1390
- * @permissionScope Manage Submissions
1391
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1392
- * @permissionScope Manage Orders
1393
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1394
- * @permissionScope Manage form submissions.
1395
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1396
- * @permissionScope Read Orders
1397
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1398
- * @permissionScope Read Submissions
1399
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1400
- * @applicableIdentity APP
1401
- * @fqn wix.forms.v4.FormSubmissionService.ListDeletedSubmissions
1402
- */
1403
- export async function listDeletedSubmissions(formId, options) {
1404
- // @ts-ignore
1405
- const { httpClient, sideEffects } = arguments[2];
1406
- const payload = renameKeysFromSDKRequestToRESTRequest({
1407
- formId: formId,
1408
- submissionIds: options?.submissionIds,
1409
- paging: options?.paging,
1410
- statuses: options?.statuses,
1411
- });
1412
- const reqOpts = ambassadorWixFormsV4Submission.listDeletedSubmissions(payload);
1413
- sideEffects?.onSiteCall?.();
1414
- try {
1415
- const result = await httpClient.request(reqOpts);
1416
- sideEffects?.onSuccess?.(result);
1417
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1418
- }
1419
- catch (err) {
1420
- const transformedError = sdkTransformError(err, {
1421
- spreadPathsToArguments: {},
1422
- explicitPathsToArguments: {
1423
- formId: '$[0]',
1424
- submissionIds: '$[1].submissionIds',
1425
- paging: '$[1].paging',
1426
- statuses: '$[1].statuses',
1427
- },
1428
- singleArgumentUnchanged: false,
1429
- }, ['formId', 'options']);
1430
- sideEffects?.onError?.(err);
1431
- throw transformedError;
1432
- }
1433
- }
1434
- /**
1435
- * Get deleted submission
1436
- * @param submissionId - Submission id.
1437
- * @public
1438
- * @documentationMaturity preview
1439
- * @requiredField submissionId
1440
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1441
- * @permissionScope Manage Submissions
1442
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1443
- * @permissionScope Manage Orders
1444
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1445
- * @permissionScope Manage form submissions.
1446
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1447
- * @permissionScope Read Orders
1448
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1449
- * @permissionScope Read Submissions
1450
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1451
- * @applicableIdentity APP
1452
- * @fqn wix.forms.v4.FormSubmissionService.GetDeletedSubmission
1453
- */
1454
- export async function getDeletedSubmission(submissionId) {
1455
- // @ts-ignore
1456
- const { httpClient, sideEffects } = arguments[1];
1457
- const payload = renameKeysFromSDKRequestToRESTRequest({
1458
- submissionId: submissionId,
1459
- });
1460
- const reqOpts = ambassadorWixFormsV4Submission.getDeletedSubmission(payload);
1461
- sideEffects?.onSiteCall?.();
1462
- try {
1463
- const result = await httpClient.request(reqOpts);
1464
- sideEffects?.onSuccess?.(result);
1465
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1466
- }
1467
- catch (err) {
1468
- const transformedError = sdkTransformError(err, {
1469
- spreadPathsToArguments: {},
1470
- explicitPathsToArguments: { submissionId: '$[0]' },
1471
- singleArgumentUnchanged: false,
1472
- }, ['submissionId']);
1473
- sideEffects?.onError?.(err);
1474
- throw transformedError;
1475
- }
1476
- }
1477
- /**
1478
- * Deprecated on '2023-08-08'. Use QuerySubmissionsByNamespace.
1479
- * @param query - Query options.
1480
- * @public
1481
- * @documentationMaturity preview
1482
- * @requiredField query
1483
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1484
- * @permissionScope Manage Submissions
1485
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1486
- * @permissionScope Manage Orders
1487
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1488
- * @permissionScope Manage form submissions.
1489
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1490
- * @permissionScope Read Orders
1491
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1492
- * @permissionScope Read Submissions
1493
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1494
- * @applicableIdentity APP
1495
- * @fqn wix.forms.v4.FormSubmissionService.QuerySubmission
1496
- * @deprecated
1497
- * @replacedBy com.wixpress.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
1498
- * @targetRemovalDate 2025-04-01
1499
- */
1500
- export async function querySubmission(query, options) {
1501
- // @ts-ignore
1502
- const { httpClient, sideEffects } = arguments[2];
1503
- const payload = renameKeysFromSDKRequestToRESTRequest({
1504
- query: query,
1505
- onlyYourOwn: options?.onlyYourOwn,
1506
- });
1507
- const reqOpts = ambassadorWixFormsV4Submission.querySubmission(payload);
1508
- sideEffects?.onSiteCall?.();
1509
- try {
1510
- const result = await httpClient.request(reqOpts);
1511
- sideEffects?.onSuccess?.(result);
1512
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1513
- }
1514
- catch (err) {
1515
- const transformedError = sdkTransformError(err, {
1516
- spreadPathsToArguments: {},
1517
- explicitPathsToArguments: {
1518
- query: '$[0]',
1519
- onlyYourOwn: '$[1].onlyYourOwn',
1520
- },
1521
- singleArgumentUnchanged: false,
1522
- }, ['query', 'options']);
1523
- sideEffects?.onError?.(err);
1524
- throw transformedError;
1525
- }
1526
- }
1527
- /**
1528
- * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.
1529
- * <br>
1530
- *
1531
- * Returns a list of up to 100 submissions, given the provided paging, filtering, and sorting.
1532
- *
1533
- * You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
1534
- *
1535
- * For field support for filters and sorting, see [Form Submissions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/crm/forms/form-submissions/filter-and-sort).option
1536
- *
1537
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
1538
- * @param search - Query options.
1539
- * @public
1540
- * @documentationMaturity preview
1541
- * @requiredField search
1542
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1543
- * @permissionScope Manage Submissions
1544
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1545
- * @permissionScope Manage Orders
1546
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1547
- * @permissionScope Manage form submissions.
1548
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1549
- * @permissionScope Read Orders
1550
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1551
- * @permissionScope Read Submissions
1552
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1553
- * @applicableIdentity APP
1554
- * @fqn wix.forms.v4.FormSubmissionService.SearchSubmissionsByNamespace
1555
- */
1556
- export async function searchSubmissionsByNamespace(search) {
1557
- // @ts-ignore
1558
- const { httpClient, sideEffects } = arguments[1];
1559
- const payload = renameKeysFromSDKRequestToRESTRequest({ search: search });
1560
- const reqOpts = ambassadorWixFormsV4Submission.searchSubmissionsByNamespace(payload);
1561
- sideEffects?.onSiteCall?.();
1562
- try {
1563
- const result = await httpClient.request(reqOpts);
1564
- sideEffects?.onSuccess?.(result);
1565
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1566
- }
1567
- catch (err) {
1568
- const transformedError = sdkTransformError(err, {
1569
- spreadPathsToArguments: {},
1570
- explicitPathsToArguments: { search: '$[0]' },
1571
- singleArgumentUnchanged: false,
1572
- }, ['search']);
1573
- sideEffects?.onError?.(err);
1574
- throw transformedError;
1575
- }
1576
- }
1577
- /**
1578
- * Creates a query to retrieve a list of submissions.
1579
- *
1580
- *
1581
- * The `querySubmissionsByNamespace()` method builds a query to retrieve a list of submissions from the specified namespace and returns a [`SubmissionsQueryBuilder`](#submissionsquerybuilder) object.
1582
- * >**Note:** You can only query submissions from a specified namespace. Use the query filter on the `namespace` field, otherwise you will receive an error.
1583
- *
1584
- * The returned object contains the query definition, which is typically used to run the query using the [`find()`](#submissionsquerybuilder/find) method.
1585
- *
1586
- * You can refine the query by chaining `SubmissionsQueryBuilder` methods onto the query. `SubmissionsQueryBuilder` methods enable you to sort, filter, and control the results that `querySubmissionsByNamespace()` returns.
1587
- *
1588
- * The following `SubmissionsQueryBuilder` methods are supported for `querySubmissionsByNamespace()`. For a full description of the Submissions object, see the object returned for the [`items`](#submissionsqueryresult/items) property in [`SubmissionsQueryResult`](#submissionsqueryresult).
1589
- * @public
1590
- * @param options - Query options.
1591
- * @permissionScope Manage Submissions
1592
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1593
- * @permissionScope Manage Orders
1594
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1595
- * @permissionScope Manage form submissions.
1596
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1597
- * @permissionScope Read Orders
1598
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1599
- * @permissionScope Read Submissions
1600
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1601
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1602
- * @applicableIdentity APP
1603
- * @fqn wix.forms.v4.FormSubmissionService.QuerySubmissionsByNamespace
1604
- */
1605
- export function querySubmissionsByNamespace(options) {
1606
- // @ts-ignore
1607
- const { httpClient, sideEffects } = arguments[1];
1608
- return queryBuilder({
1609
- func: async (payload) => {
1610
- const reqOpts = ambassadorWixFormsV4Submission.querySubmissionsByNamespace({
1611
- ...payload,
1612
- ...(options ?? {}),
1613
- });
1614
- sideEffects?.onSiteCall?.();
1615
- try {
1616
- const result = await httpClient.request(reqOpts);
1617
- sideEffects?.onSuccess?.(result);
1618
- return result;
1619
- }
1620
- catch (err) {
1621
- sideEffects?.onError?.(err);
1622
- throw err;
1623
- }
1624
- },
1625
- requestTransformer: (query) => {
1626
- const args = [query, options];
1627
- return renameKeysFromSDKRequestToRESTRequest({
1628
- ...args?.[1],
1629
- query: args?.[0],
1630
- });
1631
- },
1632
- responseTransformer: ({ data, }) => {
1633
- const transformedData = renameKeysFromRESTResponseToSDKResponse(data);
1634
- return {
1635
- items: transformedData?.submissions,
1636
- pagingMetadata: transformedData?.metadata,
1637
- };
1638
- },
1639
- errorTransformer: (err) => {
1640
- const transformedError = sdkTransformError(err, {
1641
- spreadPathsToArguments: {},
1642
- explicitPathsToArguments: { query: '$[0]' },
1643
- singleArgumentUnchanged: false,
1644
- });
1645
- throw transformedError;
1646
- },
1647
- pagingMethod: 'CURSOR',
1648
- transformationPaths: {},
1649
- });
1650
- }
1651
- /**
1652
- * > **Note:** The Form Submission API only works with the Wix Forms app. Call [GetAppInstance](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/get-app-instance) to confirm that the app named `wix_forms` is installed on the site.
1653
- * <br>
1654
- * Counts the number of submissions belonging to forms that were filtered and contain a provided expression.
1655
- * @param filter - A filter object. Must filter by namespace.
1656
- * @public
1657
- * @documentationMaturity preview
1658
- * @requiredField filter
1659
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1660
- * @permissionScope Manage Submissions
1661
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1662
- * @permissionScope Manage Orders
1663
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1664
- * @permissionScope Manage form submissions.
1665
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1666
- * @permissionScope Read Orders
1667
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1668
- * @permissionScope Read Submissions
1669
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1670
- * @applicableIdentity APP
1671
- * @fqn wix.forms.v4.FormSubmissionService.CountSubmissionsByFilter
1672
- */
1673
- export async function countSubmissionsByFilter(filter, options) {
1674
- // @ts-ignore
1675
- const { httpClient, sideEffects } = arguments[2];
1676
- const payload = renameKeysFromSDKRequestToRESTRequest({
1677
- filter: filter,
1678
- search: options?.search,
1679
- });
1680
- const reqOpts = ambassadorWixFormsV4Submission.countSubmissionsByFilter(payload);
1681
- sideEffects?.onSiteCall?.();
1682
- try {
1683
- const result = await httpClient.request(reqOpts);
1684
- sideEffects?.onSuccess?.(result);
1685
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1686
- }
1687
- catch (err) {
1688
- const transformedError = sdkTransformError(err, {
1689
- spreadPathsToArguments: {},
1690
- explicitPathsToArguments: { filter: '$[0]', search: '$[1].search' },
1691
- singleArgumentUnchanged: false,
1692
- }, ['filter', 'options']);
1693
- sideEffects?.onError?.(err);
1694
- throw transformedError;
1695
- }
1696
- }
1697
- /**
1698
- * Counts the number of submissions belonging to the specified forms.
1699
- *
1700
- *
1701
- * The `countSubmissions()` function is useful for analytics and tracking purposes. For example, if you have a contact form on your website, you can use this function to track how many submissions it receives daily, weekly, or monthly.
1702
- * @public
1703
- * @requiredField formIds
1704
- * @requiredField namespace
1705
- * @param namespace - The app which the form submissions belong to. For example, the namespace for the Wix Forms app is `wix.form_app.form`. Call `getSubmission()` to retrieve the namespace.
1706
- * @param formIds - Form IDs which submissions should be counted.
1707
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1708
- * @permissionScope Manage Submissions
1709
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1710
- * @permissionScope Manage Orders
1711
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1712
- * @permissionScope Manage form submissions.
1713
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1714
- * @permissionScope Read Orders
1715
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1716
- * @permissionScope Read Submissions
1717
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1718
- * @applicableIdentity APP
1719
- * @fqn wix.forms.v4.FormSubmissionService.CountSubmissions
1720
- */
1721
- export async function countSubmissions(formIds, namespace, options) {
1722
- // @ts-ignore
1723
- const { httpClient, sideEffects } = arguments[3];
1724
- const payload = renameKeysFromSDKRequestToRESTRequest({
1725
- formIds: formIds,
1726
- namespace: namespace,
1727
- statuses: options?.statuses,
1728
- });
1729
- const reqOpts = ambassadorWixFormsV4Submission.countSubmissions(payload);
1730
- sideEffects?.onSiteCall?.();
1731
- try {
1732
- const result = await httpClient.request(reqOpts);
1733
- sideEffects?.onSuccess?.(result);
1734
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1735
- }
1736
- catch (err) {
1737
- const transformedError = sdkTransformError(err, {
1738
- spreadPathsToArguments: {},
1739
- explicitPathsToArguments: {
1740
- formIds: '$[0]',
1741
- namespace: '$[1]',
1742
- statuses: '$[2].statuses',
1743
- },
1744
- singleArgumentUnchanged: false,
1745
- }, ['formIds', 'namespace', 'options']);
1746
- sideEffects?.onError?.(err);
1747
- throw transformedError;
1748
- }
1749
- }
1750
- /**
1751
- * > **Note:**
1752
- * > The Submissions API is only available in the Wix Studio editor.
1753
- *
1754
- * Counts the number of submissions belonging to the specified forms.
1755
- * @param formIds - Form IDs.
1756
- * @param namespace - Identifies the app which the form submissions belong to. For example, the namespace for the Wix Forms App is `"wix.form_app.form"`. The namespace of a submission can be retrieved using the Get Submission endpoint.
1757
- * @public
1758
- * @documentationMaturity preview
1759
- * @requiredField formIds
1760
- * @requiredField namespace
1761
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1762
- * @permissionScope Manage Submissions
1763
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1764
- * @permissionScope Manage Orders
1765
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1766
- * @permissionScope Manage form submissions.
1767
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1768
- * @permissionScope Read Orders
1769
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1770
- * @permissionScope Read Submissions
1771
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1772
- * @applicableIdentity APP
1773
- * @fqn wix.forms.v4.FormSubmissionService.CountDeletedSubmissions
1774
- */
1775
- export async function countDeletedSubmissions(formIds, namespace, options) {
1776
- // @ts-ignore
1777
- const { httpClient, sideEffects } = arguments[3];
1778
- const payload = renameKeysFromSDKRequestToRESTRequest({
1779
- formIds: formIds,
1780
- namespace: namespace,
1781
- statuses: options?.statuses,
1782
- });
1783
- const reqOpts = ambassadorWixFormsV4Submission.countDeletedSubmissions(payload);
1784
- sideEffects?.onSiteCall?.();
1785
- try {
1786
- const result = await httpClient.request(reqOpts);
1787
- sideEffects?.onSuccess?.(result);
1788
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1789
- }
1790
- catch (err) {
1791
- const transformedError = sdkTransformError(err, {
1792
- spreadPathsToArguments: {},
1793
- explicitPathsToArguments: {
1794
- formIds: '$[0]',
1795
- namespace: '$[1]',
1796
- statuses: '$[2].statuses',
1797
- },
1798
- singleArgumentUnchanged: false,
1799
- }, ['formIds', 'namespace', 'options']);
1800
- sideEffects?.onError?.(err);
1801
- throw transformedError;
1802
- }
1803
- }
1804
- /**
1805
- * Retrieves a URL generated by the [Media Manager](https://www.wix.com/velo/reference/wix-media-v2/files/generatefileuploadurl) to use when creating a submission that includes a field for uploading files.
1806
- * > **Note:** You need at least a [Standard Premium](https://support.wix.com/en/article/choosing-a-premium-plan) plan for your site to upload files.
1807
- *
1808
- *
1809
- * To learn how external clients can use the generated upload URL to upload a file to the Media Manager, see [Upload API](https://www.wix.com/velo/reference/wix-media-v2/files/upload-api).
1810
- * @param formId - Form ID.
1811
- * @param filename - Name of file to upload.
1812
- * @param mimeType - [Mime type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#) of file to upload.
1813
- *
1814
- * For example, `'image/png'`
1815
- * @public
1816
- * @requiredField filename
1817
- * @requiredField formId
1818
- * @requiredField mimeType
1819
- * @permissionId WIX_FORMS.SUBMISSION_CREATE
1820
- * @permissionScope Manage Submissions
1821
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1822
- * @permissionScope Manage form submissions.
1823
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1824
- * @permissionScope Manage Challenges
1825
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
1826
- * @applicableIdentity APP
1827
- * @applicableIdentity VISITOR
1828
- * @fqn wix.forms.v4.FormSubmissionService.GetMediaUploadURL
1829
- */
1830
- export async function getMediaUploadUrl(formId, filename, mimeType) {
1831
- // @ts-ignore
1832
- const { httpClient, sideEffects } = arguments[3];
1833
- const payload = renameKeysFromSDKRequestToRESTRequest({
1834
- formId: formId,
1835
- filename: filename,
1836
- mimeType: mimeType,
1837
- });
1838
- const reqOpts = ambassadorWixFormsV4Submission.getMediaUploadUrl(payload);
1839
- sideEffects?.onSiteCall?.();
1840
- try {
1841
- const result = await httpClient.request(reqOpts);
1842
- sideEffects?.onSuccess?.(result);
1843
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1844
- }
1845
- catch (err) {
1846
- const transformedError = sdkTransformError(err, {
1847
- spreadPathsToArguments: {},
1848
- explicitPathsToArguments: {
1849
- formId: '$[0]',
1850
- filename: '$[1]',
1851
- mimeType: '$[2]',
1852
- },
1853
- singleArgumentUnchanged: false,
1854
- }, ['formId', 'filename', 'mimeType']);
1855
- sideEffects?.onError?.(err);
1856
- throw transformedError;
1857
- }
1858
- }
1859
- /**
1860
- * Marks form submissions as "seen".
1861
- *
1862
- *
1863
- * This function marks the submissions as if they were seen by the site owner. Only site collaborators with the **[Manage Submission](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions)** permissions can mark submissions.
1864
- * @public
1865
- * @requiredField formId
1866
- * @requiredField ids
1867
- * @param ids - IDs of submissions to mark as seen.
1868
- * @param formId - ID of the form which the submissions belong to.
1869
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1870
- * @permissionScope Manage Submissions
1871
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1872
- * @permissionScope Manage Orders
1873
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1874
- * @permissionScope Manage form submissions.
1875
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1876
- * @permissionScope Read Orders
1877
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1878
- * @permissionScope Read Submissions
1879
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1880
- * @applicableIdentity APP
1881
- * @fqn wix.forms.v4.FormSubmissionService.BulkMarkSubmissionsAsSeen
1882
- */
1883
- export async function bulkMarkSubmissionsAsSeen(ids, formId) {
1884
- // @ts-ignore
1885
- const { httpClient, sideEffects } = arguments[2];
1886
- const payload = renameKeysFromSDKRequestToRESTRequest({
1887
- ids: ids,
1888
- formId: formId,
1889
- });
1890
- const reqOpts = ambassadorWixFormsV4Submission.bulkMarkSubmissionsAsSeen(payload);
1891
- sideEffects?.onSiteCall?.();
1892
- try {
1893
- const result = await httpClient.request(reqOpts);
1894
- sideEffects?.onSuccess?.(result);
1895
- }
1896
- catch (err) {
1897
- const transformedError = sdkTransformError(err, {
1898
- spreadPathsToArguments: {},
1899
- explicitPathsToArguments: { ids: '$[0]', formId: '$[1]' },
1900
- singleArgumentUnchanged: false,
1901
- }, ['ids', 'formId']);
1902
- sideEffects?.onError?.(err);
1903
- throw transformedError;
1904
- }
1905
- }
1906
- /**
1907
- * Gets submission as document which may include the document download url if the document is ready.
1908
- * @param submissionId - Submission ID.
1909
- * @public
1910
- * @documentationMaturity preview
1911
- * @requiredField submissionId
1912
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
1913
- * @permissionScope Manage Submissions
1914
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1915
- * @permissionScope Manage form submissions.
1916
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1917
- * @applicableIdentity APP
1918
- * @fqn wix.forms.v4.FormSubmissionService.GetSubmissionDownloadUrl
1919
- */
1920
- export async function getSubmissionDownloadUrl(submissionId) {
1921
- // @ts-ignore
1922
- const { httpClient, sideEffects } = arguments[1];
1923
- const payload = renameKeysFromSDKRequestToRESTRequest({
1924
- submissionId: submissionId,
1925
- });
1926
- const reqOpts = ambassadorWixFormsV4Submission.getSubmissionDownloadUrl(payload);
1927
- sideEffects?.onSiteCall?.();
1928
- try {
1929
- const result = await httpClient.request(reqOpts);
1930
- sideEffects?.onSuccess?.(result);
1931
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1932
- }
1933
- catch (err) {
1934
- const transformedError = sdkTransformError(err, {
1935
- spreadPathsToArguments: {},
1936
- explicitPathsToArguments: { submissionId: '$[0]' },
1937
- singleArgumentUnchanged: false,
1938
- }, ['submissionId']);
1939
- sideEffects?.onError?.(err);
1940
- throw transformedError;
1941
- }
1942
- }
1943
- /**
1944
- * Retrieves a submission formatted by language
1945
- * @param submissionId - Submission ID.
1946
- * @public
1947
- * @documentationMaturity preview
1948
- * @requiredField submissionId
1949
- * @permissionId WIX_FORMS.SUBMISSION_READ_ANY
1950
- * @permissionScope Manage Submissions
1951
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1952
- * @permissionScope Manage Orders
1953
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
1954
- * @permissionScope Manage form submissions.
1955
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
1956
- * @permissionScope Read Orders
1957
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
1958
- * @permissionScope Read Submissions
1959
- * @permissionScopeId SCOPE.DC-FORMS.READ-SUBMISSIONS
1960
- * @applicableIdentity APP
1961
- * @fqn wix.forms.v4.FormSubmissionService.GetFormattedSubmission
1962
- */
1963
- export async function getFormattedSubmission(submissionId) {
1964
- // @ts-ignore
1965
- const { httpClient, sideEffects } = arguments[1];
1966
- const payload = renameKeysFromSDKRequestToRESTRequest({
1967
- submissionId: submissionId,
1968
- });
1969
- const reqOpts = ambassadorWixFormsV4Submission.getFormattedSubmission(payload);
1970
- sideEffects?.onSiteCall?.();
1971
- try {
1972
- const result = await httpClient.request(reqOpts);
1973
- sideEffects?.onSuccess?.(result);
1974
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1975
- }
1976
- catch (err) {
1977
- const transformedError = sdkTransformError(err, {
1978
- spreadPathsToArguments: {},
1979
- explicitPathsToArguments: { submissionId: '$[0]' },
1980
- singleArgumentUnchanged: false,
1981
- }, ['submissionId']);
1982
- sideEffects?.onError?.(err);
1983
- throw transformedError;
1984
- }
1985
- }
1986
- /**
1987
- * Update Extended Fields of the Form
1988
- * @param _id - ID of the entity to update.
1989
- * @param namespace - Identifier for the app whose extended fields are being updated.
1990
- * @public
1991
- * @documentationMaturity preview
1992
- * @requiredField _id
1993
- * @requiredField namespace
1994
- * @requiredField options
1995
- * @requiredField options.namespaceData
1996
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
1997
- * @permissionScope Manage Submissions
1998
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
1999
- * @permissionScope Manage form submissions.
2000
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
2001
- * @applicableIdentity APP
2002
- * @fqn wix.forms.v4.FormSubmissionService.UpdateExtendedFields
2003
- */
2004
- export async function updateExtendedFields(_id, namespace, options) {
2005
- // @ts-ignore
2006
- const { httpClient, sideEffects } = arguments[3];
2007
- const payload = renameKeysFromSDKRequestToRESTRequest({
2008
- id: _id,
2009
- namespace: namespace,
2010
- namespaceData: options?.namespaceData,
2011
- });
2012
- const reqOpts = ambassadorWixFormsV4Submission.updateExtendedFields(payload);
2013
- sideEffects?.onSiteCall?.();
2014
- try {
2015
- const result = await httpClient.request(reqOpts);
2016
- sideEffects?.onSuccess?.(result);
2017
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2018
- }
2019
- catch (err) {
2020
- const transformedError = sdkTransformError(err, {
2021
- spreadPathsToArguments: {},
2022
- explicitPathsToArguments: {
2023
- id: '$[0]',
2024
- namespace: '$[1]',
2025
- namespaceData: '$[2].namespaceData',
2026
- },
2027
- singleArgumentUnchanged: false,
2028
- }, ['_id', 'namespace', 'options']);
2029
- sideEffects?.onError?.(err);
2030
- throw transformedError;
2031
- }
2032
- }
2033
- /**
2034
- * Bulk update tags on form submissions.
2035
- * @param submissionIds - Submission IDs to update tags for.
2036
- * @internal
2037
- * @documentationMaturity preview
2038
- * @requiredField submissionIds
2039
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
2040
- * @permissionScope Manage Submissions
2041
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
2042
- * @permissionScope Manage form submissions.
2043
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
2044
- * @applicableIdentity APP
2045
- * @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTags
2046
- */
2047
- export async function bulkUpdateFormSubmissionTags(submissionIds, options) {
2048
- // @ts-ignore
2049
- const { httpClient, sideEffects } = arguments[2];
2050
- const payload = renameKeysFromSDKRequestToRESTRequest({
2051
- submissionIds: submissionIds,
2052
- assignTags: options?.assignTags,
2053
- unassignTags: options?.unassignTags,
2054
- });
2055
- const reqOpts = ambassadorWixFormsV4Submission.bulkUpdateFormSubmissionTags(payload);
2056
- sideEffects?.onSiteCall?.();
2057
- try {
2058
- const result = await httpClient.request(reqOpts);
2059
- sideEffects?.onSuccess?.(result);
2060
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2061
- }
2062
- catch (err) {
2063
- const transformedError = sdkTransformError(err, {
2064
- spreadPathsToArguments: {},
2065
- explicitPathsToArguments: {
2066
- submissionIds: '$[0]',
2067
- assignTags: '$[1].assignTags',
2068
- unassignTags: '$[1].unassignTags',
2069
- },
2070
- singleArgumentUnchanged: false,
2071
- }, ['submissionIds', 'options']);
2072
- sideEffects?.onError?.(err);
2073
- throw transformedError;
2074
- }
2075
- }
2076
- /**
2077
- * Bulk update tags on form submissions by filter.
2078
- * @param filter - Filter to select the submission to update
2079
- * @internal
2080
- * @documentationMaturity preview
2081
- * @requiredField filter
2082
- * @permissionId WIX_FORMS.SUBMISSION_UPDATE_ANY
2083
- * @permissionScope Manage Submissions
2084
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
2085
- * @permissionScope Manage form submissions.
2086
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
2087
- * @applicableIdentity APP
2088
- * @fqn wix.forms.v4.FormSubmissionService.BulkUpdateFormSubmissionTagsByFilter
2089
- */
2090
- export async function bulkUpdateFormSubmissionTagsByFilter(filter, options) {
2091
- // @ts-ignore
2092
- const { httpClient, sideEffects } = arguments[2];
2093
- const payload = renameKeysFromSDKRequestToRESTRequest({
2094
- filter: filter,
2095
- assignTags: options?.assignTags,
2096
- unassignTags: options?.unassignTags,
2097
- });
2098
- const reqOpts = ambassadorWixFormsV4Submission.bulkUpdateFormSubmissionTagsByFilter(payload);
2099
- sideEffects?.onSiteCall?.();
2100
- try {
2101
- const result = await httpClient.request(reqOpts);
2102
- sideEffects?.onSuccess?.(result);
2103
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2104
- }
2105
- catch (err) {
2106
- const transformedError = sdkTransformError(err, {
2107
- spreadPathsToArguments: {},
2108
- explicitPathsToArguments: {
2109
- filter: '$[0]',
2110
- assignTags: '$[1].assignTags',
2111
- unassignTags: '$[1].unassignTags',
2112
- },
2113
- singleArgumentUnchanged: false,
2114
- }, ['filter', 'options']);
2115
- sideEffects?.onError?.(err);
2116
- throw transformedError;
2117
- }
2118
- }
2119
- /**
2120
- * Called to validate submission before creation.
2121
- * @param submission - Submission to validate.
2122
- * @public
2123
- * @documentationMaturity preview
2124
- * @requiredField submission
2125
- * @permissionId WIX_FORMS.SUBMISSION_CREATE
2126
- * @permissionScope Manage Submissions
2127
- * @permissionScopeId SCOPE.DC-FORMS.MANAGE-SUBMISSIONS
2128
- * @permissionScope Manage form submissions.
2129
- * @permissionScopeId SCOPE.FORMS.MANAGE-SUBMISSIONS
2130
- * @permissionScope Manage Challenges
2131
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
2132
- * @applicableIdentity APP
2133
- * @applicableIdentity VISITOR
2134
- * @fqn wix.forms.v4.FormSubmissionService.ValidateFormSubmission
2135
- */
2136
- export async function validateFormSubmission(submission, options) {
2137
- // @ts-ignore
2138
- const { httpClient, sideEffects } = arguments[2];
2139
- const payload = renameKeysFromSDKRequestToRESTRequest({
2140
- submission: submission,
2141
- additionalMetadata: options?.additionalMetadata,
2142
- });
2143
- const reqOpts = ambassadorWixFormsV4Submission.validateFormSubmission(payload);
2144
- sideEffects?.onSiteCall?.();
2145
- try {
2146
- const result = await httpClient.request(reqOpts);
2147
- sideEffects?.onSuccess?.(result);
2148
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2149
- }
2150
- catch (err) {
2151
- const transformedError = sdkTransformError(err, {
2152
- spreadPathsToArguments: {},
2153
- explicitPathsToArguments: {
2154
- submission: '$[0]',
2155
- additionalMetadata: '$[1].additionalMetadata',
2156
- },
2157
- singleArgumentUnchanged: false,
2158
- }, ['submission', 'options']);
2159
- sideEffects?.onError?.(err);
2160
- throw transformedError;
2161
- }
2162
- }
2163
- //# sourceMappingURL=forms-v4-submission-submissions.universal.js.map