@wix/auto_sdk_forms_submissions 1.0.117 → 1.0.118
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{forms-v4-submission-submissions.universal-BBHYv5E8.d.ts → forms-v4-submission-submissions.universal-C1P4RpS_.d.ts} +686 -8
- package/build/cjs/index.d.ts +3 -3
- package/build/cjs/index.js +152 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +152 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +725 -7
- package/build/cjs/meta.js +133 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +175 -3
- package/build/cjs/schemas.js +250 -1
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/{forms-v4-submission-submissions.universal-BBHYv5E8.d.mts → forms-v4-submission-submissions.universal-C1P4RpS_.d.mts} +686 -8
- package/build/es/index.d.mts +3 -3
- package/build/es/index.mjs +142 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +142 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +725 -7
- package/build/es/meta.mjs +123 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +175 -3
- package/build/es/schemas.mjs +250 -1
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/{forms-v4-submission-submissions.universal-D3uoXTdA.d.ts → forms-v4-submission-submissions.universal-D6YYlji6.d.ts} +686 -8
- package/build/internal/cjs/index.d.ts +3 -3
- package/build/internal/cjs/index.js +152 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +152 -2
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +725 -7
- package/build/internal/cjs/meta.js +133 -1
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +175 -3
- package/build/internal/cjs/schemas.js +250 -1
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/{forms-v4-submission-submissions.universal-D3uoXTdA.d.mts → forms-v4-submission-submissions.universal-D6YYlji6.d.mts} +686 -8
- package/build/internal/es/index.d.mts +3 -3
- package/build/internal/es/index.mjs +142 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +142 -2
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +725 -7
- package/build/internal/es/meta.mjs +123 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +175 -3
- package/build/internal/es/schemas.mjs +250 -1
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/schemas.d.ts
CHANGED
|
@@ -18,6 +18,178 @@ declare const UpsertContactFromSubmissionResponse: z.ZodObject<{
|
|
|
18
18
|
}>>;
|
|
19
19
|
newContact: z.ZodOptional<z.ZodBoolean>;
|
|
20
20
|
}, z.core.$strip>>;
|
|
21
|
+
upsertContactResponse: z.ZodOptional<z.ZodObject<{
|
|
22
|
+
contact: z.ZodOptional<z.ZodObject<{
|
|
23
|
+
_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
24
|
+
revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
25
|
+
_createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
26
|
+
_updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
27
|
+
externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
28
|
+
name: z.ZodOptional<z.ZodObject<{
|
|
29
|
+
first: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
30
|
+
last: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
31
|
+
}, z.core.$strip>>;
|
|
32
|
+
email: z.ZodOptional<z.ZodObject<{
|
|
33
|
+
email: z.ZodOptional<z.ZodString>;
|
|
34
|
+
subscriptionStatus: z.ZodOptional<z.ZodObject<{
|
|
35
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
36
|
+
PENDING: "PENDING";
|
|
37
|
+
NOT_SET: "NOT_SET";
|
|
38
|
+
NO_SUBSCRIPTION_STATUS: "NO_SUBSCRIPTION_STATUS";
|
|
39
|
+
SUBSCRIBED: "SUBSCRIBED";
|
|
40
|
+
UNSUBSCRIBED: "UNSUBSCRIBED";
|
|
41
|
+
}>>;
|
|
42
|
+
_updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
43
|
+
}, z.core.$strip>>;
|
|
44
|
+
deliverabilityStatus: z.ZodOptional<z.ZodEnum<{
|
|
45
|
+
NOT_SET: "NOT_SET";
|
|
46
|
+
VALID: "VALID";
|
|
47
|
+
BOUNCED: "BOUNCED";
|
|
48
|
+
SPAM_COMPLAINT: "SPAM_COMPLAINT";
|
|
49
|
+
INACTIVE: "INACTIVE";
|
|
50
|
+
}>>;
|
|
51
|
+
}, z.core.$strip>>;
|
|
52
|
+
additionalEmails: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
53
|
+
email: z.ZodOptional<z.ZodString>;
|
|
54
|
+
}, z.core.$strip>>>;
|
|
55
|
+
phone: z.ZodOptional<z.ZodObject<{
|
|
56
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
57
|
+
MAIN: "MAIN";
|
|
58
|
+
HOME: "HOME";
|
|
59
|
+
OTHER: "OTHER";
|
|
60
|
+
MOBILE: "MOBILE";
|
|
61
|
+
WORK: "WORK";
|
|
62
|
+
FAX: "FAX";
|
|
63
|
+
}>>;
|
|
64
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
65
|
+
e164: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
66
|
+
subscriptionStatus: z.ZodOptional<z.ZodObject<{
|
|
67
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
68
|
+
PENDING: "PENDING";
|
|
69
|
+
NOT_SET: "NOT_SET";
|
|
70
|
+
NO_SUBSCRIPTION_STATUS: "NO_SUBSCRIPTION_STATUS";
|
|
71
|
+
SUBSCRIBED: "SUBSCRIBED";
|
|
72
|
+
UNSUBSCRIBED: "UNSUBSCRIBED";
|
|
73
|
+
}>>;
|
|
74
|
+
_updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
75
|
+
}, z.core.$strip>>;
|
|
76
|
+
deliverabilityStatus: z.ZodOptional<z.ZodEnum<{
|
|
77
|
+
NOT_SET: "NOT_SET";
|
|
78
|
+
VALID: "VALID";
|
|
79
|
+
NO_PHONE_DELIVERABILITY_STATUS: "NO_PHONE_DELIVERABILITY_STATUS";
|
|
80
|
+
INVALID: "INVALID";
|
|
81
|
+
}>>;
|
|
82
|
+
}, z.core.$strip>>;
|
|
83
|
+
additionalPhones: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
84
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
85
|
+
MAIN: "MAIN";
|
|
86
|
+
HOME: "HOME";
|
|
87
|
+
OTHER: "OTHER";
|
|
88
|
+
MOBILE: "MOBILE";
|
|
89
|
+
WORK: "WORK";
|
|
90
|
+
FAX: "FAX";
|
|
91
|
+
}>>;
|
|
92
|
+
phone: z.ZodOptional<z.ZodString>;
|
|
93
|
+
e164: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
94
|
+
}, z.core.$strip>>>;
|
|
95
|
+
addresses: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
96
|
+
tag: z.ZodOptional<z.ZodEnum<{
|
|
97
|
+
HOME: "HOME";
|
|
98
|
+
OTHER: "OTHER";
|
|
99
|
+
WORK: "WORK";
|
|
100
|
+
BILLING: "BILLING";
|
|
101
|
+
SHIPPING: "SHIPPING";
|
|
102
|
+
}>>;
|
|
103
|
+
address: z.ZodOptional<z.ZodObject<{
|
|
104
|
+
city: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
105
|
+
subdivision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
106
|
+
country: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
107
|
+
postalCode: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
108
|
+
addressLine1: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
109
|
+
addressLine2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
110
|
+
}, z.core.$strip>>;
|
|
111
|
+
defaultAddress: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
112
|
+
_id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
113
|
+
recipient: z.ZodOptional<z.ZodObject<{
|
|
114
|
+
firstName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
115
|
+
lastName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
116
|
+
company: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
117
|
+
phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
118
|
+
}, z.core.$strip>>;
|
|
119
|
+
}, z.core.$strip>>>;
|
|
120
|
+
company: z.ZodOptional<z.ZodObject<{
|
|
121
|
+
name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
122
|
+
jobTitle: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
123
|
+
}, z.core.$strip>>;
|
|
124
|
+
locale: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
125
|
+
birthdate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
126
|
+
timeZone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
127
|
+
assigneeId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
128
|
+
locationIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
129
|
+
image: z.ZodOptional<z.ZodString>;
|
|
130
|
+
source: z.ZodOptional<z.ZodObject<{
|
|
131
|
+
userId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
132
|
+
appId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
133
|
+
additionalInfo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
134
|
+
}, z.core.$strip>>;
|
|
135
|
+
lastActivity: z.ZodOptional<z.ZodObject<{
|
|
136
|
+
date: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
137
|
+
templateId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
138
|
+
}, z.core.$strip>>;
|
|
139
|
+
memberInfo: z.ZodOptional<z.ZodObject<{
|
|
140
|
+
memberId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
141
|
+
signupDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
142
|
+
email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
143
|
+
emailVerified: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
144
|
+
emailVerificationRequired: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
145
|
+
status: z.ZodOptional<z.ZodEnum<{
|
|
146
|
+
PENDING: "PENDING";
|
|
147
|
+
ACTIVE: "ACTIVE";
|
|
148
|
+
BLOCKED: "BLOCKED";
|
|
149
|
+
OFFLINE: "OFFLINE";
|
|
150
|
+
}>>;
|
|
151
|
+
profileInfo: z.ZodOptional<z.ZodObject<{
|
|
152
|
+
nickname: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
153
|
+
privacyStatus: z.ZodOptional<z.ZodEnum<{
|
|
154
|
+
PUBLIC: "PUBLIC";
|
|
155
|
+
PRIVATE: "PRIVATE";
|
|
156
|
+
}>>;
|
|
157
|
+
reported: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
158
|
+
muted: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
|
|
159
|
+
photo: z.ZodOptional<z.ZodString>;
|
|
160
|
+
}, z.core.$strip>>;
|
|
161
|
+
userInfo: z.ZodOptional<z.ZodObject<{
|
|
162
|
+
userId: z.ZodOptional<z.ZodString>;
|
|
163
|
+
role: z.ZodOptional<z.ZodEnum<{
|
|
164
|
+
MEMBER: "MEMBER";
|
|
165
|
+
OWNER: "OWNER";
|
|
166
|
+
CONTRIBUTOR: "CONTRIBUTOR";
|
|
167
|
+
}>>;
|
|
168
|
+
}, z.core.$strip>>;
|
|
169
|
+
sessionInfo: z.ZodOptional<z.ZodObject<{
|
|
170
|
+
lastWebLogin: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
171
|
+
lastMobileLogin: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
|
|
172
|
+
mobileAppNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
173
|
+
}, z.core.$strip>>;
|
|
174
|
+
groupInfo: z.ZodOptional<z.ZodObject<{
|
|
175
|
+
groupIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
176
|
+
}, z.core.$strip>>;
|
|
177
|
+
}, z.core.$strip>>;
|
|
178
|
+
tags: z.ZodOptional<z.ZodObject<{
|
|
179
|
+
privateTags: z.ZodOptional<z.ZodObject<{
|
|
180
|
+
tagIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
181
|
+
}, z.core.$strip>>;
|
|
182
|
+
}, z.core.$strip>>;
|
|
183
|
+
extendedFields: z.ZodOptional<z.ZodObject<{
|
|
184
|
+
namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
|
|
185
|
+
}, z.core.$strip>>;
|
|
186
|
+
}, z.core.$strip>>;
|
|
187
|
+
action: z.ZodOptional<z.ZodEnum<{
|
|
188
|
+
UPDATED: "UPDATED";
|
|
189
|
+
CREATED: "CREATED";
|
|
190
|
+
}>>;
|
|
191
|
+
imageUploadId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
|
|
192
|
+
}, z.core.$strip>>;
|
|
21
193
|
}, z.core.$strip>;
|
|
22
194
|
declare const CreateSubmissionRequest: z.ZodObject<{
|
|
23
195
|
submission: z.ZodObject<{
|
|
@@ -840,8 +1012,8 @@ declare const SearchSubmissionsByNamespaceRequest: z.ZodObject<{
|
|
|
840
1012
|
fieldName: z.ZodOptional<z.ZodEnum<{
|
|
841
1013
|
_id: "_id";
|
|
842
1014
|
_createdDate: "_createdDate";
|
|
843
|
-
formId: "formId";
|
|
844
1015
|
status: "status";
|
|
1016
|
+
formId: "formId";
|
|
845
1017
|
}>>;
|
|
846
1018
|
order: z.ZodOptional<z.ZodEnum<{
|
|
847
1019
|
ASC: "ASC";
|
|
@@ -1017,13 +1189,13 @@ declare const QuerySubmissionsByNamespaceRequest: z.ZodObject<{
|
|
|
1017
1189
|
contactId: "contactId";
|
|
1018
1190
|
_createdDate: "_createdDate";
|
|
1019
1191
|
_updatedDate: "_updatedDate";
|
|
1020
|
-
formId: "formId";
|
|
1021
1192
|
status: "status";
|
|
1193
|
+
formId: "formId";
|
|
1022
1194
|
seen: "seen";
|
|
1195
|
+
"submitter.userId": "submitter.userId";
|
|
1023
1196
|
"submitter.memberId": "submitter.memberId";
|
|
1024
1197
|
"submitter.visitorId": "submitter.visitorId";
|
|
1025
1198
|
"submitter.applicationId": "submitter.applicationId";
|
|
1026
|
-
"submitter.userId": "submitter.userId";
|
|
1027
1199
|
"orderDetails.checkoutId": "orderDetails.checkoutId";
|
|
1028
1200
|
}>>;
|
|
1029
1201
|
order: z.ZodOptional<z.ZodEnum<{
|
package/build/cjs/schemas.js
CHANGED
|
@@ -110,7 +110,256 @@ var UpsertContactFromSubmissionResponse = z.object({
|
|
|
110
110
|
newContact: z.boolean().describe(
|
|
111
111
|
"Indicates whether the contact was just created or already existed.\n\nIf the contact was just created, returns `true`.\nIf it already existed, returns `false`."
|
|
112
112
|
).optional()
|
|
113
|
-
}).describe("Submit contact response.").optional()
|
|
113
|
+
}).describe("Submit contact response.").optional(),
|
|
114
|
+
upsertContactResponse: z.object({
|
|
115
|
+
contact: z.object({
|
|
116
|
+
_id: z.string().describe("Contact ID.").regex(
|
|
117
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
118
|
+
"Must be a valid GUID"
|
|
119
|
+
).optional().nullable(),
|
|
120
|
+
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
121
|
+
"Revision number, which increments by 1 each time the Contact is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the Contact.\n\nIgnored when creating a Contact."
|
|
122
|
+
).optional().nullable(),
|
|
123
|
+
_createdDate: z.date().describe("Date and time the Contact was created.").optional().nullable(),
|
|
124
|
+
_updatedDate: z.date().describe("Date and time the Contact was last updated.").optional().nullable(),
|
|
125
|
+
externalId: z.string().describe(
|
|
126
|
+
"Contact External ID. Used to identify contacts from external systems.\nThis field can only be set once and cannot be updated after creation."
|
|
127
|
+
).max(100).optional().nullable(),
|
|
128
|
+
name: z.object({
|
|
129
|
+
first: z.string().describe("Contact's first name.").max(1e3).optional().nullable(),
|
|
130
|
+
last: z.string().describe("Contact's last name.").max(1e3).optional().nullable()
|
|
131
|
+
}).describe(
|
|
132
|
+
"Contact's name information including first and last name."
|
|
133
|
+
).optional(),
|
|
134
|
+
email: z.object({
|
|
135
|
+
email: z.string().describe(
|
|
136
|
+
"Main email address for the contact. Used for communication and contact matching."
|
|
137
|
+
).email().max(320).optional(),
|
|
138
|
+
subscriptionStatus: z.object({
|
|
139
|
+
status: z.enum([
|
|
140
|
+
"NO_SUBSCRIPTION_STATUS",
|
|
141
|
+
"NOT_SET",
|
|
142
|
+
"PENDING",
|
|
143
|
+
"SUBSCRIBED",
|
|
144
|
+
"UNSUBSCRIBED"
|
|
145
|
+
]).describe(
|
|
146
|
+
"Indicates the recipient's opt-in or opt-out status for marketing communications.\n\n- `NOT_SET`: No subscription status specified. Default value.\n- `PENDING`: Subscription confirmation was requested, but recipient hasn't confirmed yet.\n- `SUBSCRIBED`: Recipient has explicitly opted in to receive marketing communications.\n- `UNSUBSCRIBED`: Recipient has opted out of marketing communications."
|
|
147
|
+
).optional(),
|
|
148
|
+
_updatedDate: z.date().describe(
|
|
149
|
+
"Date and time when the subscription status was last updated."
|
|
150
|
+
).optional().nullable()
|
|
151
|
+
}).describe(
|
|
152
|
+
"Indicates the recipient's opt-in or opt-out status for marketing emails.\nThis field is read-only and managed by the subscription system."
|
|
153
|
+
).optional(),
|
|
154
|
+
deliverabilityStatus: z.enum([
|
|
155
|
+
"NOT_SET",
|
|
156
|
+
"VALID",
|
|
157
|
+
"BOUNCED",
|
|
158
|
+
"SPAM_COMPLAINT",
|
|
159
|
+
"INACTIVE"
|
|
160
|
+
]).describe(
|
|
161
|
+
"Indicates the last reported delivery status of emails sent to this address.\nThis field is read-only and updated automatically by the email delivery system.\n\n- `NOT_SET`: No delivery status reported. Default value.\n- `VALID`: Emails are being successfully delivered to this address.\n- `BOUNCED`: The last email to this address bounced or was rejected by the recipient's email server.\n- `SPAM_COMPLAINT`: Recipient registered a spam complaint with their email provider.\n- `INACTIVE`: Multiple emails have been delivered without any engagement from the recipient."
|
|
162
|
+
).optional()
|
|
163
|
+
}).describe(
|
|
164
|
+
"The main email of the contact with subscription status and deliverability information.\nThis email is used for contact matching and deduplication logic."
|
|
165
|
+
).optional(),
|
|
166
|
+
additionalEmails: z.array(
|
|
167
|
+
z.object({
|
|
168
|
+
email: z.string().describe(
|
|
169
|
+
"Additional email address for the contact.\nDoes not affect subscription status or contact matching logic."
|
|
170
|
+
).email().max(320).optional()
|
|
171
|
+
})
|
|
172
|
+
).max(10).optional(),
|
|
173
|
+
phone: z.object({
|
|
174
|
+
tag: z.enum(["OTHER", "MAIN", "HOME", "MOBILE", "WORK", "FAX"]).describe(
|
|
175
|
+
"Phone type classification. Helps categorize the phone number's purpose.\nDefault value: OTHER"
|
|
176
|
+
).optional(),
|
|
177
|
+
phone: z.string().describe(
|
|
178
|
+
"Primary phone number for the contact. Used for communication and contact matching."
|
|
179
|
+
).min(1).max(50).optional(),
|
|
180
|
+
e164: z.string().describe(
|
|
181
|
+
"Phone number in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format (e.g., +12345550123).\nThis field is automatically generated from the phone field if it represents a valid E.164 number."
|
|
182
|
+
).max(50).optional().nullable(),
|
|
183
|
+
subscriptionStatus: z.object({
|
|
184
|
+
status: z.enum([
|
|
185
|
+
"NO_SUBSCRIPTION_STATUS",
|
|
186
|
+
"NOT_SET",
|
|
187
|
+
"PENDING",
|
|
188
|
+
"SUBSCRIBED",
|
|
189
|
+
"UNSUBSCRIBED"
|
|
190
|
+
]).describe(
|
|
191
|
+
"Indicates the recipient's opt-in or opt-out status for marketing communications.\n\n- `NOT_SET`: No subscription status specified. Default value.\n- `PENDING`: Subscription confirmation was requested, but recipient hasn't confirmed yet.\n- `SUBSCRIBED`: Recipient has explicitly opted in to receive marketing communications.\n- `UNSUBSCRIBED`: Recipient has opted out of marketing communications."
|
|
192
|
+
).optional(),
|
|
193
|
+
_updatedDate: z.date().describe(
|
|
194
|
+
"Date and time when the subscription status was last updated."
|
|
195
|
+
).optional().nullable()
|
|
196
|
+
}).describe(
|
|
197
|
+
"Indicates the recipient's opt-in or opt-out status for SMS/text message marketing.\nThis field is read-only and managed by the subscription system."
|
|
198
|
+
).optional(),
|
|
199
|
+
deliverabilityStatus: z.enum([
|
|
200
|
+
"NO_PHONE_DELIVERABILITY_STATUS",
|
|
201
|
+
"NOT_SET",
|
|
202
|
+
"VALID",
|
|
203
|
+
"INVALID"
|
|
204
|
+
]).describe(
|
|
205
|
+
"Indicates the delivery status for SMS messages sent to this phone number.\nThis field is read-only and updated automatically by the SMS delivery system.\n- `NO_PHONE_DELIVERABILITY_STATUS`: No status exists. Used when the phone is not a valid E164 number.\n- `NOT_SET`: No delivery status reported. Default when the phone is a valid E164 number.\n- `VALID`: Last message was sent and delivered successfully.\n- `INVALID`: The number is invalid (landline, number disconnected, etc.)."
|
|
206
|
+
).optional()
|
|
207
|
+
}).describe(
|
|
208
|
+
"The main phone of the contact with subscription status and deliverability information.\nThis phone is used for contact matching and deduplication logic.\nAt least one of name, email, or phone is required for contact creation."
|
|
209
|
+
).optional(),
|
|
210
|
+
additionalPhones: z.array(
|
|
211
|
+
z.object({
|
|
212
|
+
tag: z.enum(["OTHER", "MAIN", "HOME", "MOBILE", "WORK", "FAX"]).describe(
|
|
213
|
+
"Phone type classification for the additional phone number.\nDefault value: OTHER"
|
|
214
|
+
).optional(),
|
|
215
|
+
phone: z.string().describe(
|
|
216
|
+
"Additional phone number for the contact.\nDoes not affect subscription status or contact matching logic."
|
|
217
|
+
).min(1).max(50).optional(),
|
|
218
|
+
e164: z.string().describe(
|
|
219
|
+
"Additional phone number in [ITU E.164 international](https://www.itu.int/rec/T-REC-E.164/) format (e.g., +12345550123).\nThis field is automatically generated from the phone field if it represents a valid E.164 number."
|
|
220
|
+
).max(50).optional().nullable()
|
|
221
|
+
})
|
|
222
|
+
).max(10).optional(),
|
|
223
|
+
addresses: z.array(
|
|
224
|
+
z.object({
|
|
225
|
+
tag: z.enum(["OTHER", "HOME", "WORK", "BILLING", "SHIPPING"]).describe(
|
|
226
|
+
"Address type classification. Helps categorize the address purpose.\nDefault value: OTHER"
|
|
227
|
+
).optional(),
|
|
228
|
+
address: z.object({
|
|
229
|
+
city: z.string().optional().nullable(),
|
|
230
|
+
subdivision: z.string().optional().nullable(),
|
|
231
|
+
country: z.string().optional().nullable(),
|
|
232
|
+
postalCode: z.string().optional().nullable(),
|
|
233
|
+
addressLine1: z.string().optional().nullable(),
|
|
234
|
+
addressLine2: z.string().optional().nullable()
|
|
235
|
+
}).describe(
|
|
236
|
+
"Physical address information including street, city, country, and postal code.\nContains structured address data following common address formatting standards."
|
|
237
|
+
).optional(),
|
|
238
|
+
defaultAddress: z.boolean().describe(
|
|
239
|
+
"Indicates whether this address is the primary/default address for the contact.\nOnly one address can be designated as default per contact.\nIf no address is explicitly set as default, the first address automatically becomes the default.\nAll other addresses will have this field set to false."
|
|
240
|
+
).optional().nullable(),
|
|
241
|
+
_id: z.string().describe("Address ID").regex(
|
|
242
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
243
|
+
"Must be a valid GUID"
|
|
244
|
+
).optional().nullable(),
|
|
245
|
+
recipient: z.object({
|
|
246
|
+
firstName: z.string().describe("Recipient's first name.").max(1e3).optional().nullable(),
|
|
247
|
+
lastName: z.string().describe("Recipient's last name.").max(1e3).optional().nullable(),
|
|
248
|
+
company: z.string().describe("Recipient's company name.").max(1e3).optional().nullable(),
|
|
249
|
+
phone: z.string().describe("Recipient's phone number.").min(1).max(50).optional().nullable()
|
|
250
|
+
}).describe(
|
|
251
|
+
"Address recipient information for delivery purposes"
|
|
252
|
+
).optional()
|
|
253
|
+
})
|
|
254
|
+
).max(50).optional(),
|
|
255
|
+
company: z.object({
|
|
256
|
+
name: z.string().describe("Contact's company name.").max(1e3).optional().nullable(),
|
|
257
|
+
jobTitle: z.string().describe("Contact's job title.").max(1e3).optional().nullable()
|
|
258
|
+
}).describe(
|
|
259
|
+
"Contact's company information including company name and job title."
|
|
260
|
+
).optional(),
|
|
261
|
+
locale: z.string().describe(
|
|
262
|
+
"Locale in\n[IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nTypically, this is a lowercase 2-letter language code,\nfollowed by a hyphen, followed by an uppercase 2-letter country code.\nFor example, `en-US` for U.S. English, and `de-DE` for Germany German."
|
|
263
|
+
).optional().nullable(),
|
|
264
|
+
birthdate: z.string().describe(
|
|
265
|
+
"Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`."
|
|
266
|
+
).optional().nullable(),
|
|
267
|
+
timeZone: z.string().describe(
|
|
268
|
+
"IANA time zone identifier for the contact's location.\nValid values are IANA time zone IDs, such as 'Europe/Rome' or 'America/New_York'."
|
|
269
|
+
).max(50).optional().nullable(),
|
|
270
|
+
assigneeId: z.string().describe(
|
|
271
|
+
"Site contributor user ID assigned to manage communication with this contact.\nMust be a valid GUID referencing an existing site contributor.\nOnly one assignee can be set per contact."
|
|
272
|
+
).regex(
|
|
273
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
274
|
+
"Must be a valid GUID"
|
|
275
|
+
).optional().nullable(),
|
|
276
|
+
locationIds: z.array(z.string()).max(50).optional(),
|
|
277
|
+
image: z.string().describe("Contact's profile image.").optional(),
|
|
278
|
+
source: z.object({
|
|
279
|
+
userId: z.string().describe("ID of the user who created this contact.").regex(
|
|
280
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
281
|
+
"Must be a valid GUID"
|
|
282
|
+
).optional().nullable(),
|
|
283
|
+
appId: z.string().describe("ID of the application that created this contact.").regex(
|
|
284
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
285
|
+
"Must be a valid GUID"
|
|
286
|
+
).optional().nullable(),
|
|
287
|
+
additionalInfo: z.string().describe(
|
|
288
|
+
"Additional information about the contact's origin or creation context."
|
|
289
|
+
).max(1e3).optional().nullable()
|
|
290
|
+
}).describe(
|
|
291
|
+
"Details about the origin of the contact.\nThis field is immutable and set automatically when the contact is created."
|
|
292
|
+
).optional(),
|
|
293
|
+
lastActivity: z.object({
|
|
294
|
+
date: z.date().describe(
|
|
295
|
+
"Date and time when the contact's most recent activity occurred."
|
|
296
|
+
).optional().nullable(),
|
|
297
|
+
templateId: z.string().describe(
|
|
298
|
+
"ID of the activity template that defines the type of activity performed.\nReferences a template in the contacts activity log system."
|
|
299
|
+
).regex(
|
|
300
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
301
|
+
"Must be a valid GUID"
|
|
302
|
+
).optional().nullable()
|
|
303
|
+
}).describe(
|
|
304
|
+
"Details about the contact's most recent activity on the site.\nIncludes activity date and template ID. This field is read-only and updated automatically."
|
|
305
|
+
).optional(),
|
|
306
|
+
memberInfo: z.object({
|
|
307
|
+
memberId: z.string().describe("Member ID").regex(
|
|
308
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
309
|
+
"Must be a valid GUID"
|
|
310
|
+
).optional().nullable(),
|
|
311
|
+
signupDate: z.date().describe("Signup date").optional().nullable(),
|
|
312
|
+
email: z.string().describe("Login email").email().optional().nullable(),
|
|
313
|
+
emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
|
|
314
|
+
emailVerificationRequired: z.boolean().describe(
|
|
315
|
+
"Indicates whether the member is required to verify their email"
|
|
316
|
+
).optional().nullable(),
|
|
317
|
+
status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
|
|
318
|
+
"Member status.\n- `PENDING`: Member created and is waiting for approval by site owner.\n- `ACTIVE`: Member can log in to the site.\n- `BLOCKED': Member is blocked and cannot log in to the site.\n- `OFFLINE`: Member is a [managed writer](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and cannot log in to the site."
|
|
319
|
+
).optional(),
|
|
320
|
+
profileInfo: z.object({
|
|
321
|
+
nickname: z.string().describe("Nickname").max(255).optional().nullable(),
|
|
322
|
+
privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
|
|
323
|
+
reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
|
|
324
|
+
muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
|
|
325
|
+
photo: z.string().describe("Profile photo").optional()
|
|
326
|
+
}).describe("Profile info").optional(),
|
|
327
|
+
userInfo: z.object({
|
|
328
|
+
userId: z.string().describe("User ID").regex(
|
|
329
|
+
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
330
|
+
"Must be a valid GUID"
|
|
331
|
+
).optional(),
|
|
332
|
+
role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
|
|
333
|
+
}).describe("User info").optional(),
|
|
334
|
+
sessionInfo: z.object({
|
|
335
|
+
lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
|
|
336
|
+
lastMobileLogin: z.date().describe(
|
|
337
|
+
"Last time the member logged in to one of the mobile apps"
|
|
338
|
+
).optional().nullable(),
|
|
339
|
+
mobileAppNames: z.array(z.string()).max(50).optional()
|
|
340
|
+
}).describe("Session info").optional(),
|
|
341
|
+
groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
|
|
342
|
+
}).describe(
|
|
343
|
+
"Contact's site membership information including member ID, status, and profile details.\nThis field is read-only and populated automatically when the contact is also a site member."
|
|
344
|
+
).optional(),
|
|
345
|
+
tags: z.object({
|
|
346
|
+
privateTags: z.object({ tagIds: z.array(z.string()).max(1e3).optional() }).describe(
|
|
347
|
+
"Tags that are exposed to anyone with access to the entity."
|
|
348
|
+
).optional()
|
|
349
|
+
}).describe(
|
|
350
|
+
"Tags assigned to the contact for organization and filtering."
|
|
351
|
+
).optional(),
|
|
352
|
+
extendedFields: z.object({
|
|
353
|
+
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
354
|
+
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
355
|
+
).optional()
|
|
356
|
+
}).describe(
|
|
357
|
+
"Extended fields for storing custom contact data beyond the standard fields.\nAllows adding custom properties specific to business needs."
|
|
358
|
+
).optional()
|
|
359
|
+
}).describe("Upserted contact.").optional(),
|
|
360
|
+
action: z.enum(["UPDATED", "CREATED"]).describe("The action performed on the contact.").optional(),
|
|
361
|
+
imageUploadId: z.string().describe("The upload ID of the image upload process.").max(100).optional().nullable()
|
|
362
|
+
}).describe("Upsert contact response.").optional()
|
|
114
363
|
});
|
|
115
364
|
var CreateSubmissionRequest = z.object({
|
|
116
365
|
submission: z.object({
|