@wix/forms 1.0.6 → 1.0.7

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 (7) hide show
  1. package/build/cjs/src/forms-v4-submission.types.d.ts +10 -10
  2. package/build/cjs/src/forms-v4-submission.universal.d.ts +19 -19
  3. package/build/cjs/src/forms-v4-submission.universal.js +1 -1
  4. package/build/es/src/forms-v4-submission.types.d.ts +10 -10
  5. package/build/es/src/forms-v4-submission.universal.d.ts +19 -19
  6. package/build/es/src/forms-v4-submission.universal.js +1 -1
  7. package/package.json +2 -2
package/build/cjs/src/forms-v4-submission.types.d.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  export interface FormSubmission {
2
2
  /**
3
- * Submission id.
3
+ * Form submission ID.
4
4
  * @readonly
5
5
  */
6
6
  id?: string | null;
7
- /** Id of a form to which submission belongs. */
7
+ /** ID of the form to which submission belongs. */
8
8
  formId?: string;
9
9
  /**
10
10
  * Form namespace to which submissions belong.
@@ -13,29 +13,29 @@ export interface FormSubmission {
13
13
  namespace?: string;
14
14
  /** Status of the submission. */
15
15
  status?: SubmissionStatus;
16
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
16
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
17
17
  submissions?: Record<string, any>;
18
18
  /**
19
- * Date of creation.
19
+ * Date and time the form submission was created.
20
20
  * @readonly
21
21
  */
22
22
  createdDate?: Date;
23
23
  /**
24
- * Date of last update.
24
+ * Date and time the form submission was updated.
25
25
  * @readonly
26
26
  */
27
27
  updatedDate?: Date;
28
28
  /**
29
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
29
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
30
30
  * @readonly
31
31
  */
32
32
  revision?: string | null;
33
33
  /**
34
- * Identification of submission creator
34
+ * ID of the creator of the form submission.
35
35
  * @readonly
36
36
  */
37
37
  submitter?: Submitter;
38
- /** Flag identifying if submission was read by user */
38
+ /** Whether the submission was read by a user. */
39
39
  seen?: boolean;
40
40
  }
41
41
  export declare enum SubmissionStatus {
@@ -77,7 +77,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
77
77
  serviceId?: string | null;
78
78
  /** User ID. */
79
79
  userId?: string | null;
80
- /** External app id */
80
+ /** External app ID. */
81
81
  externalAppId?: string | null;
82
82
  }
83
83
  /** @oneof */
@@ -90,7 +90,7 @@ export interface SubmitterSubmitterOneOf {
90
90
  serviceId?: string | null;
91
91
  /** User ID. */
92
92
  userId?: string | null;
93
- /** External app id */
93
+ /** External app ID. */
94
94
  externalAppId?: string | null;
95
95
  }
96
96
  export interface DomainEvent extends DomainEventBodyOneOf {
package/build/cjs/src/forms-v4-submission.universal.d.ts CHANGED
@@ -6,11 +6,11 @@ export declare const __debug: {
6
6
  };
7
7
  export interface FormSubmission {
8
8
  /**
9
- * Submission id.
9
+ * Form submission ID.
10
10
  * @readonly
11
11
  */
12
12
  _id?: string | null;
13
- /** Id of a form to which submission belongs. */
13
+ /** ID of the form to which submission belongs. */
14
14
  formId?: string;
15
15
  /**
16
16
  * Form namespace to which submissions belong.
@@ -19,29 +19,29 @@ export interface FormSubmission {
19
19
  namespace?: string;
20
20
  /** Status of the submission. */
21
21
  status?: SubmissionStatus;
22
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
22
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
23
23
  submissions?: Record<string, any>;
24
24
  /**
25
- * Date of creation.
25
+ * Date and time the form submission was created.
26
26
  * @readonly
27
27
  */
28
28
  _createdDate?: Date;
29
29
  /**
30
- * Date of last update.
30
+ * Date and time the form submission was updated.
31
31
  * @readonly
32
32
  */
33
33
  _updatedDate?: Date;
34
34
  /**
35
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
35
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
36
36
  * @readonly
37
37
  */
38
38
  revision?: string | null;
39
39
  /**
40
- * Identification of submission creator
40
+ * ID of the creator of the form submission.
41
41
  * @readonly
42
42
  */
43
43
  submitter?: Submitter;
44
- /** Flag identifying if submission was read by user */
44
+ /** Whether the submission was read by a user. */
45
45
  seen?: boolean;
46
46
  }
47
47
  export declare enum SubmissionStatus {
@@ -83,7 +83,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
83
83
  serviceId?: string | null;
84
84
  /** User ID. */
85
85
  userId?: string | null;
86
- /** External app id */
86
+ /** External app ID. */
87
87
  externalAppId?: string | null;
88
88
  }
89
89
  /** @oneof */
@@ -96,7 +96,7 @@ export interface SubmitterSubmitterOneOf {
96
96
  serviceId?: string | null;
97
97
  /** User ID. */
98
98
  userId?: string | null;
99
- /** External app id */
99
+ /** External app ID. */
100
100
  externalAppId?: string | null;
101
101
  }
102
102
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -446,7 +446,7 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
446
446
  /**
447
447
  * Updates a submission, supports partial update.
448
448
  * You need to pass the latest 'revision' for a successful update.
449
- * @param _id - Submission id.
449
+ * @param _id - Form submission ID.
450
450
  * @public
451
451
  * @documentationMaturity preview
452
452
  * @requiredField _id
@@ -458,11 +458,11 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
458
458
  export declare function updateSubmission(_id: string | null, submission: UpdateSubmission): Promise<FormSubmission>;
459
459
  export interface UpdateSubmission {
460
460
  /**
461
- * Submission id.
461
+ * Form submission ID.
462
462
  * @readonly
463
463
  */
464
464
  _id?: string | null;
465
- /** Id of a form to which submission belongs. */
465
+ /** ID of the form to which submission belongs. */
466
466
  formId?: string;
467
467
  /**
468
468
  * Form namespace to which submissions belong.
@@ -471,29 +471,29 @@ export interface UpdateSubmission {
471
471
  namespace?: string;
472
472
  /** Status of the submission. */
473
473
  status?: SubmissionStatus;
474
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
474
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
475
475
  submissions?: Record<string, any>;
476
476
  /**
477
- * Date of creation.
477
+ * Date and time the form submission was created.
478
478
  * @readonly
479
479
  */
480
480
  _createdDate?: Date;
481
481
  /**
482
- * Date of last update.
482
+ * Date and time the form submission was updated.
483
483
  * @readonly
484
484
  */
485
485
  _updatedDate?: Date;
486
486
  /**
487
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
487
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
488
488
  * @readonly
489
489
  */
490
490
  revision?: string | null;
491
491
  /**
492
- * Identification of submission creator
492
+ * ID of the creator of the form submission.
493
493
  * @readonly
494
494
  */
495
495
  submitter?: Submitter;
496
- /** Flag identifying if submission was read by user */
496
+ /** Whether the submission was read by a user. */
497
497
  seen?: boolean;
498
498
  }
499
499
  /**
package/build/cjs/src/forms-v4-submission.universal.js CHANGED
@@ -200,7 +200,7 @@ exports.getSubmission = getSubmission;
200
200
  /**
201
201
  * Updates a submission, supports partial update.
202
202
  * You need to pass the latest 'revision' for a successful update.
203
- * @param _id - Submission id.
203
+ * @param _id - Form submission ID.
204
204
  * @public
205
205
  * @documentationMaturity preview
206
206
  * @requiredField _id
package/build/es/src/forms-v4-submission.types.d.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  export interface FormSubmission {
2
2
  /**
3
- * Submission id.
3
+ * Form submission ID.
4
4
  * @readonly
5
5
  */
6
6
  id?: string | null;
7
- /** Id of a form to which submission belongs. */
7
+ /** ID of the form to which submission belongs. */
8
8
  formId?: string;
9
9
  /**
10
10
  * Form namespace to which submissions belong.
@@ -13,29 +13,29 @@ export interface FormSubmission {
13
13
  namespace?: string;
14
14
  /** Status of the submission. */
15
15
  status?: SubmissionStatus;
16
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
16
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
17
17
  submissions?: Record<string, any>;
18
18
  /**
19
- * Date of creation.
19
+ * Date and time the form submission was created.
20
20
  * @readonly
21
21
  */
22
22
  createdDate?: Date;
23
23
  /**
24
- * Date of last update.
24
+ * Date and time the form submission was updated.
25
25
  * @readonly
26
26
  */
27
27
  updatedDate?: Date;
28
28
  /**
29
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
29
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
30
30
  * @readonly
31
31
  */
32
32
  revision?: string | null;
33
33
  /**
34
- * Identification of submission creator
34
+ * ID of the creator of the form submission.
35
35
  * @readonly
36
36
  */
37
37
  submitter?: Submitter;
38
- /** Flag identifying if submission was read by user */
38
+ /** Whether the submission was read by a user. */
39
39
  seen?: boolean;
40
40
  }
41
41
  export declare enum SubmissionStatus {
@@ -77,7 +77,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
77
77
  serviceId?: string | null;
78
78
  /** User ID. */
79
79
  userId?: string | null;
80
- /** External app id */
80
+ /** External app ID. */
81
81
  externalAppId?: string | null;
82
82
  }
83
83
  /** @oneof */
@@ -90,7 +90,7 @@ export interface SubmitterSubmitterOneOf {
90
90
  serviceId?: string | null;
91
91
  /** User ID. */
92
92
  userId?: string | null;
93
- /** External app id */
93
+ /** External app ID. */
94
94
  externalAppId?: string | null;
95
95
  }
96
96
  export interface DomainEvent extends DomainEventBodyOneOf {
package/build/es/src/forms-v4-submission.universal.d.ts CHANGED
@@ -6,11 +6,11 @@ export declare const __debug: {
6
6
  };
7
7
  export interface FormSubmission {
8
8
  /**
9
- * Submission id.
9
+ * Form submission ID.
10
10
  * @readonly
11
11
  */
12
12
  _id?: string | null;
13
- /** Id of a form to which submission belongs. */
13
+ /** ID of the form to which submission belongs. */
14
14
  formId?: string;
15
15
  /**
16
16
  * Form namespace to which submissions belong.
@@ -19,29 +19,29 @@ export interface FormSubmission {
19
19
  namespace?: string;
20
20
  /** Status of the submission. */
21
21
  status?: SubmissionStatus;
22
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
22
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
23
23
  submissions?: Record<string, any>;
24
24
  /**
25
- * Date of creation.
25
+ * Date and time the form submission was created.
26
26
  * @readonly
27
27
  */
28
28
  _createdDate?: Date;
29
29
  /**
30
- * Date of last update.
30
+ * Date and time the form submission was updated.
31
31
  * @readonly
32
32
  */
33
33
  _updatedDate?: Date;
34
34
  /**
35
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
35
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
36
36
  * @readonly
37
37
  */
38
38
  revision?: string | null;
39
39
  /**
40
- * Identification of submission creator
40
+ * ID of the creator of the form submission.
41
41
  * @readonly
42
42
  */
43
43
  submitter?: Submitter;
44
- /** Flag identifying if submission was read by user */
44
+ /** Whether the submission was read by a user. */
45
45
  seen?: boolean;
46
46
  }
47
47
  export declare enum SubmissionStatus {
@@ -83,7 +83,7 @@ export interface Submitter extends SubmitterSubmitterOneOf {
83
83
  serviceId?: string | null;
84
84
  /** User ID. */
85
85
  userId?: string | null;
86
- /** External app id */
86
+ /** External app ID. */
87
87
  externalAppId?: string | null;
88
88
  }
89
89
  /** @oneof */
@@ -96,7 +96,7 @@ export interface SubmitterSubmitterOneOf {
96
96
  serviceId?: string | null;
97
97
  /** User ID. */
98
98
  userId?: string | null;
99
- /** External app id */
99
+ /** External app ID. */
100
100
  externalAppId?: string | null;
101
101
  }
102
102
  export interface DomainEvent extends DomainEventBodyOneOf {
@@ -446,7 +446,7 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
446
446
  /**
447
447
  * Updates a submission, supports partial update.
448
448
  * You need to pass the latest 'revision' for a successful update.
449
- * @param _id - Submission id.
449
+ * @param _id - Form submission ID.
450
450
  * @public
451
451
  * @documentationMaturity preview
452
452
  * @requiredField _id
@@ -458,11 +458,11 @@ export declare function getSubmission(submissionId: string): Promise<FormSubmiss
458
458
  export declare function updateSubmission(_id: string | null, submission: UpdateSubmission): Promise<FormSubmission>;
459
459
  export interface UpdateSubmission {
460
460
  /**
461
- * Submission id.
461
+ * Form submission ID.
462
462
  * @readonly
463
463
  */
464
464
  _id?: string | null;
465
- /** Id of a form to which submission belongs. */
465
+ /** ID of the form to which submission belongs. */
466
466
  formId?: string;
467
467
  /**
468
468
  * Form namespace to which submissions belong.
@@ -471,29 +471,29 @@ export interface UpdateSubmission {
471
471
  namespace?: string;
472
472
  /** Status of the submission. */
473
473
  status?: SubmissionStatus;
474
- /** Submission values where key is a target of a form field and value is a submissions for the given field. */
474
+ /** Submission values where key is a target of the form field and value is a submission for the given field. */
475
475
  submissions?: Record<string, any>;
476
476
  /**
477
- * Date of creation.
477
+ * Date and time the form submission was created.
478
478
  * @readonly
479
479
  */
480
480
  _createdDate?: Date;
481
481
  /**
482
- * Date of last update.
482
+ * Date and time the form submission was updated.
483
483
  * @readonly
484
484
  */
485
485
  _updatedDate?: Date;
486
486
  /**
487
- * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.
487
+ * Revision number, which increments by 1 each time the form submission is updated. To prevent conflicting changes, the existing revision must be used when updating a form submission.
488
488
  * @readonly
489
489
  */
490
490
  revision?: string | null;
491
491
  /**
492
- * Identification of submission creator
492
+ * ID of the creator of the form submission.
493
493
  * @readonly
494
494
  */
495
495
  submitter?: Submitter;
496
- /** Flag identifying if submission was read by user */
496
+ /** Whether the submission was read by a user. */
497
497
  seen?: boolean;
498
498
  }
499
499
  /**
package/build/es/src/forms-v4-submission.universal.js CHANGED
@@ -176,7 +176,7 @@ export function getSubmission(submissionId) {
176
176
  /**
177
177
  * Updates a submission, supports partial update.
178
178
  * You need to pass the latest 'revision' for a successful update.
179
- * @param _id - Submission id.
179
+ * @param _id - Form submission ID.
180
180
  * @public
181
181
  * @documentationMaturity preview
182
182
  * @requiredField _id
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/forms",
3
- "version": "1.0.6",
3
+ "version": "1.0.7",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "1583a683eaa325e017063b91c623e4ea977374ef014bc5a7a547bc62"
36
+ "falconPackageHash": "3e979dedb349543a1646956a475ded3f87789396409ba0fc87330b33"
37
37
  }