@wix/auto_sdk_crm_contacts-v-5 1.0.2 → 1.0.3

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 (37) hide show
  1. package/build/cjs/{contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +33 -21
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +2 -2
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +34 -22
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/cjs/schemas.js +756 -530
  9. package/build/cjs/schemas.js.map +1 -1
  10. package/build/es/{contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +33 -21
  11. package/build/es/index.d.mts +2 -2
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +2 -2
  14. package/build/es/index.typings.mjs.map +1 -1
  15. package/build/es/meta.d.mts +34 -22
  16. package/build/es/meta.mjs.map +1 -1
  17. package/build/es/schemas.mjs +756 -530
  18. package/build/es/schemas.mjs.map +1 -1
  19. package/build/internal/cjs/{contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.ts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.ts} +33 -21
  20. package/build/internal/cjs/index.d.ts +2 -2
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +34 -22
  25. package/build/internal/cjs/meta.js.map +1 -1
  26. package/build/internal/cjs/schemas.js +756 -530
  27. package/build/internal/cjs/schemas.js.map +1 -1
  28. package/build/internal/es/{contacts-v5-contact-contacts-v-5.universal-DQ0VgYqw.d.mts → contacts-v5-contact-contacts-v-5.universal-D5olkuCL.d.mts} +33 -21
  29. package/build/internal/es/index.d.mts +2 -2
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +2 -2
  32. package/build/internal/es/index.typings.mjs.map +1 -1
  33. package/build/internal/es/meta.d.mts +34 -22
  34. package/build/internal/es/meta.mjs.map +1 -1
  35. package/build/internal/es/schemas.mjs +756 -530
  36. package/build/internal/es/schemas.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -296,39 +296,45 @@ var CreateContactRequest = z.object({
296
296
  ).optional(),
297
297
  segmentIds: z.array(z.string()).max(60).optional(),
298
298
  memberInfo: z.object({
299
- memberId: z.string().describe("Member ID").regex(
299
+ memberId: z.string().describe("Member ID.").regex(
300
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
301
  "Must be a valid GUID"
302
302
  ).optional().nullable(),
303
- signupDate: z.date().describe("Signup date").optional().nullable(),
304
- email: z.string().describe("Login email").email().optional().nullable(),
305
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
303
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
304
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
305
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
306
306
  emailVerificationRequired: z.boolean().describe(
307
- "Indicates whether the member is required to verify their email"
307
+ "Whether the member is required to verify their email before they can log in."
308
308
  ).optional().nullable(),
309
309
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
310
310
  profileInfo: z.object({
311
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
311
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
312
312
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
313
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
314
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
315
- photo: z.string().describe("Profile photo").optional()
316
- }).describe("Profile info").optional(),
313
+ reported: z.boolean().describe(
314
+ "Whether the member has been reported by another member."
315
+ ).optional().nullable(),
316
+ muted: z.boolean().describe(
317
+ "Whether the member has been muted and can't post or comment on the site."
318
+ ).optional().nullable(),
319
+ photo: z.string().describe("Member's profile photo.").optional()
320
+ }).describe("Information about the member's public profile.").optional(),
317
321
  userInfo: z.object({
318
- userId: z.string().describe("User ID").regex(
322
+ userId: z.string().describe("User ID.").regex(
319
323
  /^[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}$/,
320
324
  "Must be a valid GUID"
321
325
  ).optional(),
322
326
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
323
- }).describe("User info").optional(),
327
+ }).describe("Information about the member's user account.").optional(),
324
328
  sessionInfo: z.object({
325
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
329
+ lastWebLogin: z.date().describe(
330
+ "Date and time the member last logged in to the site from a browser."
331
+ ).optional().nullable(),
326
332
  lastMobileLogin: z.date().describe(
327
- "Last time the member logged in to one of the mobile apps"
333
+ "Date and time the member last logged in from one of the mobile apps."
328
334
  ).optional().nullable(),
329
335
  mobileAppNames: z.array(z.string()).max(50).optional()
330
- }).describe("Session info").optional(),
331
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
336
+ }).describe("Information about the member's login sessions.").optional(),
337
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
332
338
  }).describe(
333
339
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
334
340
  ).optional(),
@@ -529,41 +535,47 @@ var CreateContactResponse = z.object({
529
535
  ).optional(),
530
536
  segmentIds: z.array(z.string()).max(60).optional(),
531
537
  memberInfo: z.object({
532
- memberId: z.string().describe("Member ID").regex(
538
+ memberId: z.string().describe("Member ID.").regex(
533
539
  /^[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}$/,
534
540
  "Must be a valid GUID"
535
541
  ).optional().nullable(),
536
- signupDate: z.date().describe("Signup date").optional().nullable(),
537
- email: z.string().describe("Login email").email().optional().nullable(),
538
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
542
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
543
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
544
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
539
545
  emailVerificationRequired: z.boolean().describe(
540
- "Indicates whether the member is required to verify their email"
546
+ "Whether the member is required to verify their email before they can log in."
541
547
  ).optional().nullable(),
542
548
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
543
- "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."
549
+ "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."
544
550
  ).optional(),
545
551
  profileInfo: z.object({
546
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
547
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
548
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
549
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
550
- photo: z.string().describe("Profile photo").optional()
551
- }).describe("Profile info").optional(),
552
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
553
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
554
+ "Whether the member's profile is visible to other site members and visitors."
555
+ ).optional(),
556
+ reported: z.boolean().describe("Whether the member has been reported by another member.").optional().nullable(),
557
+ muted: z.boolean().describe(
558
+ "Whether the member has been muted and can't post or comment on the site."
559
+ ).optional().nullable(),
560
+ photo: z.string().describe("Member's profile photo.").optional()
561
+ }).describe("Information about the member's public profile.").optional(),
552
562
  userInfo: z.object({
553
- userId: z.string().describe("User ID").regex(
563
+ userId: z.string().describe("User ID.").regex(
554
564
  /^[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}$/,
555
565
  "Must be a valid GUID"
556
566
  ).optional(),
557
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
558
- }).describe("User info").optional(),
567
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
568
+ }).describe("Information about the member's user account.").optional(),
559
569
  sessionInfo: z.object({
560
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
570
+ lastWebLogin: z.date().describe(
571
+ "Date and time the member last logged in to the site from a browser."
572
+ ).optional().nullable(),
561
573
  lastMobileLogin: z.date().describe(
562
- "Last time the member logged in to one of the mobile apps"
574
+ "Date and time the member last logged in from one of the mobile apps."
563
575
  ).optional().nullable(),
564
576
  mobileAppNames: z.array(z.string()).max(50).optional()
565
- }).describe("Session info").optional(),
566
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
577
+ }).describe("Information about the member's login sessions.").optional(),
578
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
567
579
  }).describe(
568
580
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
569
581
  ).optional(),
@@ -760,41 +772,47 @@ var GetContactResponse = z.object({
760
772
  ).optional(),
761
773
  segmentIds: z.array(z.string()).max(60).optional(),
762
774
  memberInfo: z.object({
763
- memberId: z.string().describe("Member ID").regex(
775
+ memberId: z.string().describe("Member ID.").regex(
764
776
  /^[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}$/,
765
777
  "Must be a valid GUID"
766
778
  ).optional().nullable(),
767
- signupDate: z.date().describe("Signup date").optional().nullable(),
768
- email: z.string().describe("Login email").email().optional().nullable(),
769
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
779
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
780
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
781
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
770
782
  emailVerificationRequired: z.boolean().describe(
771
- "Indicates whether the member is required to verify their email"
783
+ "Whether the member is required to verify their email before they can log in."
772
784
  ).optional().nullable(),
773
785
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
774
- "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."
786
+ "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."
775
787
  ).optional(),
776
788
  profileInfo: z.object({
777
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
778
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
779
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
780
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
781
- photo: z.string().describe("Profile photo").optional()
782
- }).describe("Profile info").optional(),
789
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
790
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
791
+ "Whether the member's profile is visible to other site members and visitors."
792
+ ).optional(),
793
+ reported: z.boolean().describe("Whether the member has been reported by another member.").optional().nullable(),
794
+ muted: z.boolean().describe(
795
+ "Whether the member has been muted and can't post or comment on the site."
796
+ ).optional().nullable(),
797
+ photo: z.string().describe("Member's profile photo.").optional()
798
+ }).describe("Information about the member's public profile.").optional(),
783
799
  userInfo: z.object({
784
- userId: z.string().describe("User ID").regex(
800
+ userId: z.string().describe("User ID.").regex(
785
801
  /^[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}$/,
786
802
  "Must be a valid GUID"
787
803
  ).optional(),
788
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
789
- }).describe("User info").optional(),
804
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
805
+ }).describe("Information about the member's user account.").optional(),
790
806
  sessionInfo: z.object({
791
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
807
+ lastWebLogin: z.date().describe(
808
+ "Date and time the member last logged in to the site from a browser."
809
+ ).optional().nullable(),
792
810
  lastMobileLogin: z.date().describe(
793
- "Last time the member logged in to one of the mobile apps"
811
+ "Date and time the member last logged in from one of the mobile apps."
794
812
  ).optional().nullable(),
795
813
  mobileAppNames: z.array(z.string()).max(50).optional()
796
- }).describe("Session info").optional(),
797
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
814
+ }).describe("Information about the member's login sessions.").optional(),
815
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
798
816
  }).describe(
799
817
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
800
818
  ).optional(),
@@ -983,39 +1001,45 @@ var UpdateContactRequest = z.object({
983
1001
  ).optional(),
984
1002
  segmentIds: z.array(z.string()).max(60).optional(),
985
1003
  memberInfo: z.object({
986
- memberId: z.string().describe("Member ID").regex(
1004
+ memberId: z.string().describe("Member ID.").regex(
987
1005
  /^[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}$/,
988
1006
  "Must be a valid GUID"
989
1007
  ).optional().nullable(),
990
- signupDate: z.date().describe("Signup date").optional().nullable(),
991
- email: z.string().describe("Login email").email().optional().nullable(),
992
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
1008
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
1009
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
1010
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
993
1011
  emailVerificationRequired: z.boolean().describe(
994
- "Indicates whether the member is required to verify their email"
1012
+ "Whether the member is required to verify their email before they can log in."
995
1013
  ).optional().nullable(),
996
1014
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
997
1015
  profileInfo: z.object({
998
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
1016
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
999
1017
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
1000
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
1001
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
1002
- photo: z.string().describe("Profile photo").optional()
1003
- }).describe("Profile info").optional(),
1018
+ reported: z.boolean().describe(
1019
+ "Whether the member has been reported by another member."
1020
+ ).optional().nullable(),
1021
+ muted: z.boolean().describe(
1022
+ "Whether the member has been muted and can't post or comment on the site."
1023
+ ).optional().nullable(),
1024
+ photo: z.string().describe("Member's profile photo.").optional()
1025
+ }).describe("Information about the member's public profile.").optional(),
1004
1026
  userInfo: z.object({
1005
- userId: z.string().describe("User ID").regex(
1027
+ userId: z.string().describe("User ID.").regex(
1006
1028
  /^[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}$/,
1007
1029
  "Must be a valid GUID"
1008
1030
  ).optional(),
1009
1031
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
1010
- }).describe("User info").optional(),
1032
+ }).describe("Information about the member's user account.").optional(),
1011
1033
  sessionInfo: z.object({
1012
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
1034
+ lastWebLogin: z.date().describe(
1035
+ "Date and time the member last logged in to the site from a browser."
1036
+ ).optional().nullable(),
1013
1037
  lastMobileLogin: z.date().describe(
1014
- "Last time the member logged in to one of the mobile apps"
1038
+ "Date and time the member last logged in from one of the mobile apps."
1015
1039
  ).optional().nullable(),
1016
1040
  mobileAppNames: z.array(z.string()).max(50).optional()
1017
- }).describe("Session info").optional(),
1018
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
1041
+ }).describe("Information about the member's login sessions.").optional(),
1042
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
1019
1043
  }).describe(
1020
1044
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
1021
1045
  ).optional(),
@@ -1216,41 +1240,47 @@ var UpdateContactResponse = z.object({
1216
1240
  ).optional(),
1217
1241
  segmentIds: z.array(z.string()).max(60).optional(),
1218
1242
  memberInfo: z.object({
1219
- memberId: z.string().describe("Member ID").regex(
1243
+ memberId: z.string().describe("Member ID.").regex(
1220
1244
  /^[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}$/,
1221
1245
  "Must be a valid GUID"
1222
1246
  ).optional().nullable(),
1223
- signupDate: z.date().describe("Signup date").optional().nullable(),
1224
- email: z.string().describe("Login email").email().optional().nullable(),
1225
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
1247
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
1248
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
1249
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
1226
1250
  emailVerificationRequired: z.boolean().describe(
1227
- "Indicates whether the member is required to verify their email"
1251
+ "Whether the member is required to verify their email before they can log in."
1228
1252
  ).optional().nullable(),
1229
1253
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
1230
- "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."
1254
+ "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."
1231
1255
  ).optional(),
1232
1256
  profileInfo: z.object({
1233
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
1234
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
1235
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
1236
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
1237
- photo: z.string().describe("Profile photo").optional()
1238
- }).describe("Profile info").optional(),
1257
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
1258
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
1259
+ "Whether the member's profile is visible to other site members and visitors."
1260
+ ).optional(),
1261
+ reported: z.boolean().describe("Whether the member has been reported by another member.").optional().nullable(),
1262
+ muted: z.boolean().describe(
1263
+ "Whether the member has been muted and can't post or comment on the site."
1264
+ ).optional().nullable(),
1265
+ photo: z.string().describe("Member's profile photo.").optional()
1266
+ }).describe("Information about the member's public profile.").optional(),
1239
1267
  userInfo: z.object({
1240
- userId: z.string().describe("User ID").regex(
1268
+ userId: z.string().describe("User ID.").regex(
1241
1269
  /^[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}$/,
1242
1270
  "Must be a valid GUID"
1243
1271
  ).optional(),
1244
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
1245
- }).describe("User info").optional(),
1272
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
1273
+ }).describe("Information about the member's user account.").optional(),
1246
1274
  sessionInfo: z.object({
1247
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
1275
+ lastWebLogin: z.date().describe(
1276
+ "Date and time the member last logged in to the site from a browser."
1277
+ ).optional().nullable(),
1248
1278
  lastMobileLogin: z.date().describe(
1249
- "Last time the member logged in to one of the mobile apps"
1279
+ "Date and time the member last logged in from one of the mobile apps."
1250
1280
  ).optional().nullable(),
1251
1281
  mobileAppNames: z.array(z.string()).max(50).optional()
1252
- }).describe("Session info").optional(),
1253
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
1282
+ }).describe("Information about the member's login sessions.").optional(),
1283
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
1254
1284
  }).describe(
1255
1285
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
1256
1286
  ).optional(),
@@ -1435,39 +1465,45 @@ var UpsertContactRequest = z.object({
1435
1465
  ).optional(),
1436
1466
  segmentIds: z.array(z.string()).max(60).optional(),
1437
1467
  memberInfo: z.object({
1438
- memberId: z.string().describe("Member ID").regex(
1468
+ memberId: z.string().describe("Member ID.").regex(
1439
1469
  /^[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}$/,
1440
1470
  "Must be a valid GUID"
1441
1471
  ).optional().nullable(),
1442
- signupDate: z.date().describe("Signup date").optional().nullable(),
1443
- email: z.string().describe("Login email").email().optional().nullable(),
1444
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
1472
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
1473
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
1474
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
1445
1475
  emailVerificationRequired: z.boolean().describe(
1446
- "Indicates whether the member is required to verify their email"
1476
+ "Whether the member is required to verify their email before they can log in."
1447
1477
  ).optional().nullable(),
1448
1478
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
1449
1479
  profileInfo: z.object({
1450
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
1480
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
1451
1481
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
1452
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
1453
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
1454
- photo: z.string().describe("Profile photo").optional()
1455
- }).describe("Profile info").optional(),
1482
+ reported: z.boolean().describe(
1483
+ "Whether the member has been reported by another member."
1484
+ ).optional().nullable(),
1485
+ muted: z.boolean().describe(
1486
+ "Whether the member has been muted and can't post or comment on the site."
1487
+ ).optional().nullable(),
1488
+ photo: z.string().describe("Member's profile photo.").optional()
1489
+ }).describe("Information about the member's public profile.").optional(),
1456
1490
  userInfo: z.object({
1457
- userId: z.string().describe("User ID").regex(
1491
+ userId: z.string().describe("User ID.").regex(
1458
1492
  /^[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}$/,
1459
1493
  "Must be a valid GUID"
1460
1494
  ).optional(),
1461
1495
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
1462
- }).describe("User info").optional(),
1496
+ }).describe("Information about the member's user account.").optional(),
1463
1497
  sessionInfo: z.object({
1464
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
1498
+ lastWebLogin: z.date().describe(
1499
+ "Date and time the member last logged in to the site from a browser."
1500
+ ).optional().nullable(),
1465
1501
  lastMobileLogin: z.date().describe(
1466
- "Last time the member logged in to one of the mobile apps"
1502
+ "Date and time the member last logged in from one of the mobile apps."
1467
1503
  ).optional().nullable(),
1468
1504
  mobileAppNames: z.array(z.string()).max(50).optional()
1469
- }).describe("Session info").optional(),
1470
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
1505
+ }).describe("Information about the member's login sessions.").optional(),
1506
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
1471
1507
  }).describe(
1472
1508
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
1473
1509
  ).optional(),
@@ -1677,41 +1713,49 @@ var UpsertContactResponse = z.object({
1677
1713
  ).optional(),
1678
1714
  segmentIds: z.array(z.string()).max(60).optional(),
1679
1715
  memberInfo: z.object({
1680
- memberId: z.string().describe("Member ID").regex(
1716
+ memberId: z.string().describe("Member ID.").regex(
1681
1717
  /^[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}$/,
1682
1718
  "Must be a valid GUID"
1683
1719
  ).optional().nullable(),
1684
- signupDate: z.date().describe("Signup date").optional().nullable(),
1685
- email: z.string().describe("Login email").email().optional().nullable(),
1686
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
1720
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
1721
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
1722
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
1687
1723
  emailVerificationRequired: z.boolean().describe(
1688
- "Indicates whether the member is required to verify their email"
1724
+ "Whether the member is required to verify their email before they can log in."
1689
1725
  ).optional().nullable(),
1690
1726
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
1691
- "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."
1727
+ "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."
1692
1728
  ).optional(),
1693
1729
  profileInfo: z.object({
1694
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
1695
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
1696
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
1697
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
1698
- photo: z.string().describe("Profile photo").optional()
1699
- }).describe("Profile info").optional(),
1730
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
1731
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
1732
+ "Whether the member's profile is visible to other site members and visitors."
1733
+ ).optional(),
1734
+ reported: z.boolean().describe(
1735
+ "Whether the member has been reported by another member."
1736
+ ).optional().nullable(),
1737
+ muted: z.boolean().describe(
1738
+ "Whether the member has been muted and can't post or comment on the site."
1739
+ ).optional().nullable(),
1740
+ photo: z.string().describe("Member's profile photo.").optional()
1741
+ }).describe("Information about the member's public profile.").optional(),
1700
1742
  userInfo: z.object({
1701
- userId: z.string().describe("User ID").regex(
1743
+ userId: z.string().describe("User ID.").regex(
1702
1744
  /^[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}$/,
1703
1745
  "Must be a valid GUID"
1704
1746
  ).optional(),
1705
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
1706
- }).describe("User info").optional(),
1747
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
1748
+ }).describe("Information about the member's user account.").optional(),
1707
1749
  sessionInfo: z.object({
1708
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
1750
+ lastWebLogin: z.date().describe(
1751
+ "Date and time the member last logged in to the site from a browser."
1752
+ ).optional().nullable(),
1709
1753
  lastMobileLogin: z.date().describe(
1710
- "Last time the member logged in to one of the mobile apps"
1754
+ "Date and time the member last logged in from one of the mobile apps."
1711
1755
  ).optional().nullable(),
1712
1756
  mobileAppNames: z.array(z.string()).max(50).optional()
1713
- }).describe("Session info").optional(),
1714
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
1757
+ }).describe("Information about the member's login sessions.").optional(),
1758
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
1715
1759
  }).describe(
1716
1760
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
1717
1761
  ).optional(),
@@ -1935,41 +1979,49 @@ var UpdateContactTagsResponse = z.object({
1935
1979
  ).optional(),
1936
1980
  segmentIds: z.array(z.string()).max(60).optional(),
1937
1981
  memberInfo: z.object({
1938
- memberId: z.string().describe("Member ID").regex(
1982
+ memberId: z.string().describe("Member ID.").regex(
1939
1983
  /^[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}$/,
1940
1984
  "Must be a valid GUID"
1941
1985
  ).optional().nullable(),
1942
- signupDate: z.date().describe("Signup date").optional().nullable(),
1943
- email: z.string().describe("Login email").email().optional().nullable(),
1944
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
1986
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
1987
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
1988
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
1945
1989
  emailVerificationRequired: z.boolean().describe(
1946
- "Indicates whether the member is required to verify their email"
1990
+ "Whether the member is required to verify their email before they can log in."
1947
1991
  ).optional().nullable(),
1948
1992
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
1949
- "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."
1993
+ "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."
1950
1994
  ).optional(),
1951
1995
  profileInfo: z.object({
1952
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
1953
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
1954
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
1955
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
1956
- photo: z.string().describe("Profile photo").optional()
1957
- }).describe("Profile info").optional(),
1996
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
1997
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
1998
+ "Whether the member's profile is visible to other site members and visitors."
1999
+ ).optional(),
2000
+ reported: z.boolean().describe(
2001
+ "Whether the member has been reported by another member."
2002
+ ).optional().nullable(),
2003
+ muted: z.boolean().describe(
2004
+ "Whether the member has been muted and can't post or comment on the site."
2005
+ ).optional().nullable(),
2006
+ photo: z.string().describe("Member's profile photo.").optional()
2007
+ }).describe("Information about the member's public profile.").optional(),
1958
2008
  userInfo: z.object({
1959
- userId: z.string().describe("User ID").regex(
2009
+ userId: z.string().describe("User ID.").regex(
1960
2010
  /^[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}$/,
1961
2011
  "Must be a valid GUID"
1962
2012
  ).optional(),
1963
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
1964
- }).describe("User info").optional(),
2013
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
2014
+ }).describe("Information about the member's user account.").optional(),
1965
2015
  sessionInfo: z.object({
1966
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
2016
+ lastWebLogin: z.date().describe(
2017
+ "Date and time the member last logged in to the site from a browser."
2018
+ ).optional().nullable(),
1967
2019
  lastMobileLogin: z.date().describe(
1968
- "Last time the member logged in to one of the mobile apps"
2020
+ "Date and time the member last logged in from one of the mobile apps."
1969
2021
  ).optional().nullable(),
1970
2022
  mobileAppNames: z.array(z.string()).max(50).optional()
1971
- }).describe("Session info").optional(),
1972
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
2023
+ }).describe("Information about the member's login sessions.").optional(),
2024
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
1973
2025
  }).describe(
1974
2026
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
1975
2027
  ).optional(),
@@ -2179,39 +2231,45 @@ var MergeContactsRequest = z.object({
2179
2231
  ).optional(),
2180
2232
  segmentIds: z.array(z.string()).max(60).optional(),
2181
2233
  memberInfo: z.object({
2182
- memberId: z.string().describe("Member ID").regex(
2234
+ memberId: z.string().describe("Member ID.").regex(
2183
2235
  /^[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}$/,
2184
2236
  "Must be a valid GUID"
2185
2237
  ).optional().nullable(),
2186
- signupDate: z.date().describe("Signup date").optional().nullable(),
2187
- email: z.string().describe("Login email").email().optional().nullable(),
2188
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
2238
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
2239
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
2240
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
2189
2241
  emailVerificationRequired: z.boolean().describe(
2190
- "Indicates whether the member is required to verify their email"
2242
+ "Whether the member is required to verify their email before they can log in."
2191
2243
  ).optional().nullable(),
2192
2244
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
2193
2245
  profileInfo: z.object({
2194
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
2246
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
2195
2247
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
2196
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
2197
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
2198
- photo: z.string().describe("Profile photo").optional()
2199
- }).describe("Profile info").optional(),
2248
+ reported: z.boolean().describe(
2249
+ "Whether the member has been reported by another member."
2250
+ ).optional().nullable(),
2251
+ muted: z.boolean().describe(
2252
+ "Whether the member has been muted and can't post or comment on the site."
2253
+ ).optional().nullable(),
2254
+ photo: z.string().describe("Member's profile photo.").optional()
2255
+ }).describe("Information about the member's public profile.").optional(),
2200
2256
  userInfo: z.object({
2201
- userId: z.string().describe("User ID").regex(
2257
+ userId: z.string().describe("User ID.").regex(
2202
2258
  /^[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}$/,
2203
2259
  "Must be a valid GUID"
2204
2260
  ).optional(),
2205
2261
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
2206
- }).describe("User info").optional(),
2262
+ }).describe("Information about the member's user account.").optional(),
2207
2263
  sessionInfo: z.object({
2208
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
2264
+ lastWebLogin: z.date().describe(
2265
+ "Date and time the member last logged in to the site from a browser."
2266
+ ).optional().nullable(),
2209
2267
  lastMobileLogin: z.date().describe(
2210
- "Last time the member logged in to one of the mobile apps"
2268
+ "Date and time the member last logged in from one of the mobile apps."
2211
2269
  ).optional().nullable(),
2212
2270
  mobileAppNames: z.array(z.string()).max(50).optional()
2213
- }).describe("Session info").optional(),
2214
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
2271
+ }).describe("Information about the member's login sessions.").optional(),
2272
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
2215
2273
  }).describe(
2216
2274
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
2217
2275
  ).optional(),
@@ -2425,41 +2483,49 @@ var MergeContactsResponse = z.object({
2425
2483
  ).optional(),
2426
2484
  segmentIds: z.array(z.string()).max(60).optional(),
2427
2485
  memberInfo: z.object({
2428
- memberId: z.string().describe("Member ID").regex(
2486
+ memberId: z.string().describe("Member ID.").regex(
2429
2487
  /^[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}$/,
2430
2488
  "Must be a valid GUID"
2431
2489
  ).optional().nullable(),
2432
- signupDate: z.date().describe("Signup date").optional().nullable(),
2433
- email: z.string().describe("Login email").email().optional().nullable(),
2434
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
2490
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
2491
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
2492
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
2435
2493
  emailVerificationRequired: z.boolean().describe(
2436
- "Indicates whether the member is required to verify their email"
2494
+ "Whether the member is required to verify their email before they can log in."
2437
2495
  ).optional().nullable(),
2438
2496
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
2439
- "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."
2497
+ "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."
2440
2498
  ).optional(),
2441
2499
  profileInfo: z.object({
2442
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
2443
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
2444
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
2445
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
2446
- photo: z.string().describe("Profile photo").optional()
2447
- }).describe("Profile info").optional(),
2500
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
2501
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
2502
+ "Whether the member's profile is visible to other site members and visitors."
2503
+ ).optional(),
2504
+ reported: z.boolean().describe(
2505
+ "Whether the member has been reported by another member."
2506
+ ).optional().nullable(),
2507
+ muted: z.boolean().describe(
2508
+ "Whether the member has been muted and can't post or comment on the site."
2509
+ ).optional().nullable(),
2510
+ photo: z.string().describe("Member's profile photo.").optional()
2511
+ }).describe("Information about the member's public profile.").optional(),
2448
2512
  userInfo: z.object({
2449
- userId: z.string().describe("User ID").regex(
2513
+ userId: z.string().describe("User ID.").regex(
2450
2514
  /^[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}$/,
2451
2515
  "Must be a valid GUID"
2452
2516
  ).optional(),
2453
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
2454
- }).describe("User info").optional(),
2517
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
2518
+ }).describe("Information about the member's user account.").optional(),
2455
2519
  sessionInfo: z.object({
2456
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
2520
+ lastWebLogin: z.date().describe(
2521
+ "Date and time the member last logged in to the site from a browser."
2522
+ ).optional().nullable(),
2457
2523
  lastMobileLogin: z.date().describe(
2458
- "Last time the member logged in to one of the mobile apps"
2524
+ "Date and time the member last logged in from one of the mobile apps."
2459
2525
  ).optional().nullable(),
2460
2526
  mobileAppNames: z.array(z.string()).max(50).optional()
2461
- }).describe("Session info").optional(),
2462
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
2527
+ }).describe("Information about the member's login sessions.").optional(),
2528
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
2463
2529
  }).describe(
2464
2530
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
2465
2531
  ).optional(),
@@ -2689,41 +2755,49 @@ var FindMatchingContactsResponse = z.object({
2689
2755
  ).optional(),
2690
2756
  segmentIds: z.array(z.string()).max(60).optional(),
2691
2757
  memberInfo: z.object({
2692
- memberId: z.string().describe("Member ID").regex(
2758
+ memberId: z.string().describe("Member ID.").regex(
2693
2759
  /^[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}$/,
2694
2760
  "Must be a valid GUID"
2695
2761
  ).optional().nullable(),
2696
- signupDate: z.date().describe("Signup date").optional().nullable(),
2697
- email: z.string().describe("Login email").email().optional().nullable(),
2698
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
2762
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
2763
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
2764
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
2699
2765
  emailVerificationRequired: z.boolean().describe(
2700
- "Indicates whether the member is required to verify their email"
2766
+ "Whether the member is required to verify their email before they can log in."
2701
2767
  ).optional().nullable(),
2702
2768
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
2703
- "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."
2769
+ "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."
2704
2770
  ).optional(),
2705
2771
  profileInfo: z.object({
2706
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
2707
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
2708
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
2709
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
2710
- photo: z.string().describe("Profile photo").optional()
2711
- }).describe("Profile info").optional(),
2772
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
2773
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
2774
+ "Whether the member's profile is visible to other site members and visitors."
2775
+ ).optional(),
2776
+ reported: z.boolean().describe(
2777
+ "Whether the member has been reported by another member."
2778
+ ).optional().nullable(),
2779
+ muted: z.boolean().describe(
2780
+ "Whether the member has been muted and can't post or comment on the site."
2781
+ ).optional().nullable(),
2782
+ photo: z.string().describe("Member's profile photo.").optional()
2783
+ }).describe("Information about the member's public profile.").optional(),
2712
2784
  userInfo: z.object({
2713
- userId: z.string().describe("User ID").regex(
2785
+ userId: z.string().describe("User ID.").regex(
2714
2786
  /^[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}$/,
2715
2787
  "Must be a valid GUID"
2716
2788
  ).optional(),
2717
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
2718
- }).describe("User info").optional(),
2789
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
2790
+ }).describe("Information about the member's user account.").optional(),
2719
2791
  sessionInfo: z.object({
2720
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
2792
+ lastWebLogin: z.date().describe(
2793
+ "Date and time the member last logged in to the site from a browser."
2794
+ ).optional().nullable(),
2721
2795
  lastMobileLogin: z.date().describe(
2722
- "Last time the member logged in to one of the mobile apps"
2796
+ "Date and time the member last logged in from one of the mobile apps."
2723
2797
  ).optional().nullable(),
2724
2798
  mobileAppNames: z.array(z.string()).max(50).optional()
2725
- }).describe("Session info").optional(),
2726
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
2799
+ }).describe("Information about the member's login sessions.").optional(),
2800
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
2727
2801
  }).describe(
2728
2802
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
2729
2803
  ).optional(),
@@ -2963,41 +3037,49 @@ var QueryContactsResponse = z.object({
2963
3037
  ).optional(),
2964
3038
  segmentIds: z.array(z.string()).max(60).optional(),
2965
3039
  memberInfo: z.object({
2966
- memberId: z.string().describe("Member ID").regex(
3040
+ memberId: z.string().describe("Member ID.").regex(
2967
3041
  /^[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}$/,
2968
3042
  "Must be a valid GUID"
2969
3043
  ).optional().nullable(),
2970
- signupDate: z.date().describe("Signup date").optional().nullable(),
2971
- email: z.string().describe("Login email").email().optional().nullable(),
2972
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
3044
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
3045
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
3046
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
2973
3047
  emailVerificationRequired: z.boolean().describe(
2974
- "Indicates whether the member is required to verify their email"
3048
+ "Whether the member is required to verify their email before they can log in."
2975
3049
  ).optional().nullable(),
2976
3050
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
2977
- "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."
3051
+ "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."
2978
3052
  ).optional(),
2979
3053
  profileInfo: z.object({
2980
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
2981
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
2982
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
2983
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
2984
- photo: z.string().describe("Profile photo").optional()
2985
- }).describe("Profile info").optional(),
3054
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
3055
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
3056
+ "Whether the member's profile is visible to other site members and visitors."
3057
+ ).optional(),
3058
+ reported: z.boolean().describe(
3059
+ "Whether the member has been reported by another member."
3060
+ ).optional().nullable(),
3061
+ muted: z.boolean().describe(
3062
+ "Whether the member has been muted and can't post or comment on the site."
3063
+ ).optional().nullable(),
3064
+ photo: z.string().describe("Member's profile photo.").optional()
3065
+ }).describe("Information about the member's public profile.").optional(),
2986
3066
  userInfo: z.object({
2987
- userId: z.string().describe("User ID").regex(
3067
+ userId: z.string().describe("User ID.").regex(
2988
3068
  /^[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}$/,
2989
3069
  "Must be a valid GUID"
2990
3070
  ).optional(),
2991
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
2992
- }).describe("User info").optional(),
3071
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
3072
+ }).describe("Information about the member's user account.").optional(),
2993
3073
  sessionInfo: z.object({
2994
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
3074
+ lastWebLogin: z.date().describe(
3075
+ "Date and time the member last logged in to the site from a browser."
3076
+ ).optional().nullable(),
2995
3077
  lastMobileLogin: z.date().describe(
2996
- "Last time the member logged in to one of the mobile apps"
3078
+ "Date and time the member last logged in from one of the mobile apps."
2997
3079
  ).optional().nullable(),
2998
3080
  mobileAppNames: z.array(z.string()).max(50).optional()
2999
- }).describe("Session info").optional(),
3000
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
3081
+ }).describe("Information about the member's login sessions.").optional(),
3082
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
3001
3083
  }).describe(
3002
3084
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
3003
3085
  ).optional(),
@@ -3490,41 +3572,49 @@ var SearchContactsResponse = z.object({
3490
3572
  ).optional(),
3491
3573
  segmentIds: z.array(z.string()).max(60).optional(),
3492
3574
  memberInfo: z.object({
3493
- memberId: z.string().describe("Member ID").regex(
3575
+ memberId: z.string().describe("Member ID.").regex(
3494
3576
  /^[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}$/,
3495
3577
  "Must be a valid GUID"
3496
3578
  ).optional().nullable(),
3497
- signupDate: z.date().describe("Signup date").optional().nullable(),
3498
- email: z.string().describe("Login email").email().optional().nullable(),
3499
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
3579
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
3580
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
3581
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
3500
3582
  emailVerificationRequired: z.boolean().describe(
3501
- "Indicates whether the member is required to verify their email"
3583
+ "Whether the member is required to verify their email before they can log in."
3502
3584
  ).optional().nullable(),
3503
3585
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
3504
- "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."
3586
+ "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."
3505
3587
  ).optional(),
3506
3588
  profileInfo: z.object({
3507
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
3508
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
3509
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
3510
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
3511
- photo: z.string().describe("Profile photo").optional()
3512
- }).describe("Profile info").optional(),
3589
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
3590
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
3591
+ "Whether the member's profile is visible to other site members and visitors."
3592
+ ).optional(),
3593
+ reported: z.boolean().describe(
3594
+ "Whether the member has been reported by another member."
3595
+ ).optional().nullable(),
3596
+ muted: z.boolean().describe(
3597
+ "Whether the member has been muted and can't post or comment on the site."
3598
+ ).optional().nullable(),
3599
+ photo: z.string().describe("Member's profile photo.").optional()
3600
+ }).describe("Information about the member's public profile.").optional(),
3513
3601
  userInfo: z.object({
3514
- userId: z.string().describe("User ID").regex(
3602
+ userId: z.string().describe("User ID.").regex(
3515
3603
  /^[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}$/,
3516
3604
  "Must be a valid GUID"
3517
3605
  ).optional(),
3518
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
3519
- }).describe("User info").optional(),
3606
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
3607
+ }).describe("Information about the member's user account.").optional(),
3520
3608
  sessionInfo: z.object({
3521
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
3609
+ lastWebLogin: z.date().describe(
3610
+ "Date and time the member last logged in to the site from a browser."
3611
+ ).optional().nullable(),
3522
3612
  lastMobileLogin: z.date().describe(
3523
- "Last time the member logged in to one of the mobile apps"
3613
+ "Date and time the member last logged in from one of the mobile apps."
3524
3614
  ).optional().nullable(),
3525
3615
  mobileAppNames: z.array(z.string()).max(50).optional()
3526
- }).describe("Session info").optional(),
3527
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
3616
+ }).describe("Information about the member's login sessions.").optional(),
3617
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
3528
3618
  }).describe(
3529
3619
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
3530
3620
  ).optional(),
@@ -3948,41 +4038,49 @@ var AddContactAdditionalEmailResponse = z.object({
3948
4038
  ).optional(),
3949
4039
  segmentIds: z.array(z.string()).max(60).optional(),
3950
4040
  memberInfo: z.object({
3951
- memberId: z.string().describe("Member ID").regex(
4041
+ memberId: z.string().describe("Member ID.").regex(
3952
4042
  /^[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}$/,
3953
4043
  "Must be a valid GUID"
3954
4044
  ).optional().nullable(),
3955
- signupDate: z.date().describe("Signup date").optional().nullable(),
3956
- email: z.string().describe("Login email").email().optional().nullable(),
3957
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
4045
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4046
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4047
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
3958
4048
  emailVerificationRequired: z.boolean().describe(
3959
- "Indicates whether the member is required to verify their email"
4049
+ "Whether the member is required to verify their email before they can log in."
3960
4050
  ).optional().nullable(),
3961
4051
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
3962
- "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."
4052
+ "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."
3963
4053
  ).optional(),
3964
4054
  profileInfo: z.object({
3965
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
3966
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
3967
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
3968
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
3969
- photo: z.string().describe("Profile photo").optional()
3970
- }).describe("Profile info").optional(),
4055
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4056
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4057
+ "Whether the member's profile is visible to other site members and visitors."
4058
+ ).optional(),
4059
+ reported: z.boolean().describe(
4060
+ "Whether the member has been reported by another member."
4061
+ ).optional().nullable(),
4062
+ muted: z.boolean().describe(
4063
+ "Whether the member has been muted and can't post or comment on the site."
4064
+ ).optional().nullable(),
4065
+ photo: z.string().describe("Member's profile photo.").optional()
4066
+ }).describe("Information about the member's public profile.").optional(),
3971
4067
  userInfo: z.object({
3972
- userId: z.string().describe("User ID").regex(
4068
+ userId: z.string().describe("User ID.").regex(
3973
4069
  /^[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}$/,
3974
4070
  "Must be a valid GUID"
3975
4071
  ).optional(),
3976
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
3977
- }).describe("User info").optional(),
4072
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4073
+ }).describe("Information about the member's user account.").optional(),
3978
4074
  sessionInfo: z.object({
3979
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4075
+ lastWebLogin: z.date().describe(
4076
+ "Date and time the member last logged in to the site from a browser."
4077
+ ).optional().nullable(),
3980
4078
  lastMobileLogin: z.date().describe(
3981
- "Last time the member logged in to one of the mobile apps"
4079
+ "Date and time the member last logged in from one of the mobile apps."
3982
4080
  ).optional().nullable(),
3983
4081
  mobileAppNames: z.array(z.string()).max(50).optional()
3984
- }).describe("Session info").optional(),
3985
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
4082
+ }).describe("Information about the member's login sessions.").optional(),
4083
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
3986
4084
  }).describe(
3987
4085
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
3988
4086
  ).optional(),
@@ -4204,41 +4302,49 @@ var AddContactAdditionalPhoneResponse = z.object({
4204
4302
  ).optional(),
4205
4303
  segmentIds: z.array(z.string()).max(60).optional(),
4206
4304
  memberInfo: z.object({
4207
- memberId: z.string().describe("Member ID").regex(
4305
+ memberId: z.string().describe("Member ID.").regex(
4208
4306
  /^[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}$/,
4209
4307
  "Must be a valid GUID"
4210
4308
  ).optional().nullable(),
4211
- signupDate: z.date().describe("Signup date").optional().nullable(),
4212
- email: z.string().describe("Login email").email().optional().nullable(),
4213
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
4309
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4310
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4311
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4214
4312
  emailVerificationRequired: z.boolean().describe(
4215
- "Indicates whether the member is required to verify their email"
4313
+ "Whether the member is required to verify their email before they can log in."
4216
4314
  ).optional().nullable(),
4217
4315
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
4218
- "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."
4316
+ "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."
4219
4317
  ).optional(),
4220
4318
  profileInfo: z.object({
4221
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
4222
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
4223
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
4224
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
4225
- photo: z.string().describe("Profile photo").optional()
4226
- }).describe("Profile info").optional(),
4319
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4320
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4321
+ "Whether the member's profile is visible to other site members and visitors."
4322
+ ).optional(),
4323
+ reported: z.boolean().describe(
4324
+ "Whether the member has been reported by another member."
4325
+ ).optional().nullable(),
4326
+ muted: z.boolean().describe(
4327
+ "Whether the member has been muted and can't post or comment on the site."
4328
+ ).optional().nullable(),
4329
+ photo: z.string().describe("Member's profile photo.").optional()
4330
+ }).describe("Information about the member's public profile.").optional(),
4227
4331
  userInfo: z.object({
4228
- userId: z.string().describe("User ID").regex(
4332
+ userId: z.string().describe("User ID.").regex(
4229
4333
  /^[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}$/,
4230
4334
  "Must be a valid GUID"
4231
4335
  ).optional(),
4232
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4233
- }).describe("User info").optional(),
4336
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4337
+ }).describe("Information about the member's user account.").optional(),
4234
4338
  sessionInfo: z.object({
4235
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4339
+ lastWebLogin: z.date().describe(
4340
+ "Date and time the member last logged in to the site from a browser."
4341
+ ).optional().nullable(),
4236
4342
  lastMobileLogin: z.date().describe(
4237
- "Last time the member logged in to one of the mobile apps"
4343
+ "Date and time the member last logged in from one of the mobile apps."
4238
4344
  ).optional().nullable(),
4239
4345
  mobileAppNames: z.array(z.string()).max(50).optional()
4240
- }).describe("Session info").optional(),
4241
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
4346
+ }).describe("Information about the member's login sessions.").optional(),
4347
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4242
4348
  }).describe(
4243
4349
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
4244
4350
  ).optional(),
@@ -4477,41 +4583,49 @@ var AddContactAddressResponse = z.object({
4477
4583
  ).optional(),
4478
4584
  segmentIds: z.array(z.string()).max(60).optional(),
4479
4585
  memberInfo: z.object({
4480
- memberId: z.string().describe("Member ID").regex(
4586
+ memberId: z.string().describe("Member ID.").regex(
4481
4587
  /^[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}$/,
4482
4588
  "Must be a valid GUID"
4483
4589
  ).optional().nullable(),
4484
- signupDate: z.date().describe("Signup date").optional().nullable(),
4485
- email: z.string().describe("Login email").email().optional().nullable(),
4486
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
4590
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4591
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4592
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4487
4593
  emailVerificationRequired: z.boolean().describe(
4488
- "Indicates whether the member is required to verify their email"
4594
+ "Whether the member is required to verify their email before they can log in."
4489
4595
  ).optional().nullable(),
4490
4596
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
4491
- "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."
4597
+ "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."
4492
4598
  ).optional(),
4493
4599
  profileInfo: z.object({
4494
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
4495
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
4496
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
4497
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
4498
- photo: z.string().describe("Profile photo").optional()
4499
- }).describe("Profile info").optional(),
4600
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4601
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4602
+ "Whether the member's profile is visible to other site members and visitors."
4603
+ ).optional(),
4604
+ reported: z.boolean().describe(
4605
+ "Whether the member has been reported by another member."
4606
+ ).optional().nullable(),
4607
+ muted: z.boolean().describe(
4608
+ "Whether the member has been muted and can't post or comment on the site."
4609
+ ).optional().nullable(),
4610
+ photo: z.string().describe("Member's profile photo.").optional()
4611
+ }).describe("Information about the member's public profile.").optional(),
4500
4612
  userInfo: z.object({
4501
- userId: z.string().describe("User ID").regex(
4613
+ userId: z.string().describe("User ID.").regex(
4502
4614
  /^[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}$/,
4503
4615
  "Must be a valid GUID"
4504
4616
  ).optional(),
4505
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4506
- }).describe("User info").optional(),
4617
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4618
+ }).describe("Information about the member's user account.").optional(),
4507
4619
  sessionInfo: z.object({
4508
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4620
+ lastWebLogin: z.date().describe(
4621
+ "Date and time the member last logged in to the site from a browser."
4622
+ ).optional().nullable(),
4509
4623
  lastMobileLogin: z.date().describe(
4510
- "Last time the member logged in to one of the mobile apps"
4624
+ "Date and time the member last logged in from one of the mobile apps."
4511
4625
  ).optional().nullable(),
4512
4626
  mobileAppNames: z.array(z.string()).max(50).optional()
4513
- }).describe("Session info").optional(),
4514
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
4627
+ }).describe("Information about the member's login sessions.").optional(),
4628
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4515
4629
  }).describe(
4516
4630
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
4517
4631
  ).optional(),
@@ -4728,41 +4842,49 @@ var DeleteContactAddressResponse = z.object({
4728
4842
  ).optional(),
4729
4843
  segmentIds: z.array(z.string()).max(60).optional(),
4730
4844
  memberInfo: z.object({
4731
- memberId: z.string().describe("Member ID").regex(
4845
+ memberId: z.string().describe("Member ID.").regex(
4732
4846
  /^[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}$/,
4733
4847
  "Must be a valid GUID"
4734
4848
  ).optional().nullable(),
4735
- signupDate: z.date().describe("Signup date").optional().nullable(),
4736
- email: z.string().describe("Login email").email().optional().nullable(),
4737
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
4849
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4850
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4851
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4738
4852
  emailVerificationRequired: z.boolean().describe(
4739
- "Indicates whether the member is required to verify their email"
4853
+ "Whether the member is required to verify their email before they can log in."
4740
4854
  ).optional().nullable(),
4741
4855
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
4742
- "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."
4856
+ "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."
4743
4857
  ).optional(),
4744
4858
  profileInfo: z.object({
4745
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
4746
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
4747
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
4748
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
4749
- photo: z.string().describe("Profile photo").optional()
4750
- }).describe("Profile info").optional(),
4859
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4860
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4861
+ "Whether the member's profile is visible to other site members and visitors."
4862
+ ).optional(),
4863
+ reported: z.boolean().describe(
4864
+ "Whether the member has been reported by another member."
4865
+ ).optional().nullable(),
4866
+ muted: z.boolean().describe(
4867
+ "Whether the member has been muted and can't post or comment on the site."
4868
+ ).optional().nullable(),
4869
+ photo: z.string().describe("Member's profile photo.").optional()
4870
+ }).describe("Information about the member's public profile.").optional(),
4751
4871
  userInfo: z.object({
4752
- userId: z.string().describe("User ID").regex(
4872
+ userId: z.string().describe("User ID.").regex(
4753
4873
  /^[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}$/,
4754
4874
  "Must be a valid GUID"
4755
4875
  ).optional(),
4756
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4757
- }).describe("User info").optional(),
4876
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4877
+ }).describe("Information about the member's user account.").optional(),
4758
4878
  sessionInfo: z.object({
4759
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4879
+ lastWebLogin: z.date().describe(
4880
+ "Date and time the member last logged in to the site from a browser."
4881
+ ).optional().nullable(),
4760
4882
  lastMobileLogin: z.date().describe(
4761
- "Last time the member logged in to one of the mobile apps"
4883
+ "Date and time the member last logged in from one of the mobile apps."
4762
4884
  ).optional().nullable(),
4763
4885
  mobileAppNames: z.array(z.string()).max(50).optional()
4764
- }).describe("Session info").optional(),
4765
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
4886
+ }).describe("Information about the member's login sessions.").optional(),
4887
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4766
4888
  }).describe(
4767
4889
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
4768
4890
  ).optional(),
@@ -5007,41 +5129,49 @@ var UpdateContactAddressResponse = z.object({
5007
5129
  ).optional(),
5008
5130
  segmentIds: z.array(z.string()).max(60).optional(),
5009
5131
  memberInfo: z.object({
5010
- memberId: z.string().describe("Member ID").regex(
5132
+ memberId: z.string().describe("Member ID.").regex(
5011
5133
  /^[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}$/,
5012
5134
  "Must be a valid GUID"
5013
5135
  ).optional().nullable(),
5014
- signupDate: z.date().describe("Signup date").optional().nullable(),
5015
- email: z.string().describe("Login email").email().optional().nullable(),
5016
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
5136
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5137
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5138
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5017
5139
  emailVerificationRequired: z.boolean().describe(
5018
- "Indicates whether the member is required to verify their email"
5140
+ "Whether the member is required to verify their email before they can log in."
5019
5141
  ).optional().nullable(),
5020
5142
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
5021
- "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."
5143
+ "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."
5022
5144
  ).optional(),
5023
5145
  profileInfo: z.object({
5024
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
5025
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
5026
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
5027
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
5028
- photo: z.string().describe("Profile photo").optional()
5029
- }).describe("Profile info").optional(),
5146
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5147
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
5148
+ "Whether the member's profile is visible to other site members and visitors."
5149
+ ).optional(),
5150
+ reported: z.boolean().describe(
5151
+ "Whether the member has been reported by another member."
5152
+ ).optional().nullable(),
5153
+ muted: z.boolean().describe(
5154
+ "Whether the member has been muted and can't post or comment on the site."
5155
+ ).optional().nullable(),
5156
+ photo: z.string().describe("Member's profile photo.").optional()
5157
+ }).describe("Information about the member's public profile.").optional(),
5030
5158
  userInfo: z.object({
5031
- userId: z.string().describe("User ID").regex(
5159
+ userId: z.string().describe("User ID.").regex(
5032
5160
  /^[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}$/,
5033
5161
  "Must be a valid GUID"
5034
5162
  ).optional(),
5035
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
5036
- }).describe("User info").optional(),
5163
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
5164
+ }).describe("Information about the member's user account.").optional(),
5037
5165
  sessionInfo: z.object({
5038
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5166
+ lastWebLogin: z.date().describe(
5167
+ "Date and time the member last logged in to the site from a browser."
5168
+ ).optional().nullable(),
5039
5169
  lastMobileLogin: z.date().describe(
5040
- "Last time the member logged in to one of the mobile apps"
5170
+ "Date and time the member last logged in from one of the mobile apps."
5041
5171
  ).optional().nullable(),
5042
5172
  mobileAppNames: z.array(z.string()).max(50).optional()
5043
- }).describe("Session info").optional(),
5044
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
5173
+ }).describe("Information about the member's login sessions.").optional(),
5174
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
5045
5175
  }).describe(
5046
5176
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
5047
5177
  ).optional(),
@@ -5238,39 +5368,45 @@ var BulkCreateContactsRequest = z.object({
5238
5368
  ).optional(),
5239
5369
  segmentIds: z.array(z.string()).max(60).optional(),
5240
5370
  memberInfo: z.object({
5241
- memberId: z.string().describe("Member ID").regex(
5371
+ memberId: z.string().describe("Member ID.").regex(
5242
5372
  /^[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}$/,
5243
5373
  "Must be a valid GUID"
5244
5374
  ).optional().nullable(),
5245
- signupDate: z.date().describe("Signup date").optional().nullable(),
5246
- email: z.string().describe("Login email").email().optional().nullable(),
5247
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
5375
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5376
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5377
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5248
5378
  emailVerificationRequired: z.boolean().describe(
5249
- "Indicates whether the member is required to verify their email"
5379
+ "Whether the member is required to verify their email before they can log in."
5250
5380
  ).optional().nullable(),
5251
5381
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
5252
5382
  profileInfo: z.object({
5253
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
5383
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5254
5384
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
5255
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
5256
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
5257
- photo: z.string().describe("Profile photo").optional()
5258
- }).describe("Profile info").optional(),
5385
+ reported: z.boolean().describe(
5386
+ "Whether the member has been reported by another member."
5387
+ ).optional().nullable(),
5388
+ muted: z.boolean().describe(
5389
+ "Whether the member has been muted and can't post or comment on the site."
5390
+ ).optional().nullable(),
5391
+ photo: z.string().describe("Member's profile photo.").optional()
5392
+ }).describe("Information about the member's public profile.").optional(),
5259
5393
  userInfo: z.object({
5260
- userId: z.string().describe("User ID").regex(
5394
+ userId: z.string().describe("User ID.").regex(
5261
5395
  /^[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}$/,
5262
5396
  "Must be a valid GUID"
5263
5397
  ).optional(),
5264
5398
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
5265
- }).describe("User info").optional(),
5399
+ }).describe("Information about the member's user account.").optional(),
5266
5400
  sessionInfo: z.object({
5267
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5401
+ lastWebLogin: z.date().describe(
5402
+ "Date and time the member last logged in to the site from a browser."
5403
+ ).optional().nullable(),
5268
5404
  lastMobileLogin: z.date().describe(
5269
- "Last time the member logged in to one of the mobile apps"
5405
+ "Date and time the member last logged in from one of the mobile apps."
5270
5406
  ).optional().nullable(),
5271
5407
  mobileAppNames: z.array(z.string()).max(50).optional()
5272
- }).describe("Session info").optional(),
5273
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
5408
+ }).describe("Information about the member's login sessions.").optional(),
5409
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
5274
5410
  }).describe(
5275
5411
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
5276
5412
  ).optional(),
@@ -5514,43 +5650,53 @@ var BulkCreateContactsResponse = z.object({
5514
5650
  ).optional(),
5515
5651
  segmentIds: z.array(z.string()).max(60).optional(),
5516
5652
  memberInfo: z.object({
5517
- memberId: z.string().describe("Member ID").regex(
5653
+ memberId: z.string().describe("Member ID.").regex(
5518
5654
  /^[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}$/,
5519
5655
  "Must be a valid GUID"
5520
5656
  ).optional().nullable(),
5521
- signupDate: z.date().describe("Signup date").optional().nullable(),
5522
- email: z.string().describe("Login email").email().optional().nullable(),
5523
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
5657
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5658
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5659
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5524
5660
  emailVerificationRequired: z.boolean().describe(
5525
- "Indicates whether the member is required to verify their email"
5661
+ "Whether the member is required to verify their email before they can log in."
5526
5662
  ).optional().nullable(),
5527
5663
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
5528
- "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."
5664
+ "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."
5529
5665
  ).optional(),
5530
5666
  profileInfo: z.object({
5531
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
5532
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
5533
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
5534
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
5535
- photo: z.string().describe("Profile photo").optional()
5536
- }).describe("Profile info").optional(),
5667
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5668
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
5669
+ "Whether the member's profile is visible to other site members and visitors."
5670
+ ).optional(),
5671
+ reported: z.boolean().describe(
5672
+ "Whether the member has been reported by another member."
5673
+ ).optional().nullable(),
5674
+ muted: z.boolean().describe(
5675
+ "Whether the member has been muted and can't post or comment on the site."
5676
+ ).optional().nullable(),
5677
+ photo: z.string().describe("Member's profile photo.").optional()
5678
+ }).describe("Information about the member's public profile.").optional(),
5537
5679
  userInfo: z.object({
5538
- userId: z.string().describe("User ID").regex(
5680
+ userId: z.string().describe("User ID.").regex(
5539
5681
  /^[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}$/,
5540
5682
  "Must be a valid GUID"
5541
5683
  ).optional(),
5542
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
5543
- }).describe("User info").optional(),
5684
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
5685
+ }).describe("Information about the member's user account.").optional(),
5544
5686
  sessionInfo: z.object({
5545
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5687
+ lastWebLogin: z.date().describe(
5688
+ "Date and time the member last logged in to the site from a browser."
5689
+ ).optional().nullable(),
5546
5690
  lastMobileLogin: z.date().describe(
5547
- "Last time the member logged in to one of the mobile apps"
5691
+ "Date and time the member last logged in from one of the mobile apps."
5548
5692
  ).optional().nullable(),
5549
5693
  mobileAppNames: z.array(z.string()).max(50).optional()
5550
- }).describe("Session info").optional(),
5694
+ }).describe("Information about the member's login sessions.").optional(),
5551
5695
  groupInfo: z.object({
5552
5696
  groupIds: z.array(z.string()).max(1e3).optional()
5553
- }).describe("Group info").optional()
5697
+ }).describe(
5698
+ "Information about the groups the member belongs to."
5699
+ ).optional()
5554
5700
  }).describe(
5555
5701
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
5556
5702
  ).optional(),
@@ -5763,41 +5909,49 @@ var BulkUpdateContactsRequest = z.object({
5763
5909
  ).optional(),
5764
5910
  segmentIds: z.array(z.string()).max(60).optional(),
5765
5911
  memberInfo: z.object({
5766
- memberId: z.string().describe("Member ID").regex(
5912
+ memberId: z.string().describe("Member ID.").regex(
5767
5913
  /^[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}$/,
5768
5914
  "Must be a valid GUID"
5769
5915
  ).optional().nullable(),
5770
- signupDate: z.date().describe("Signup date").optional().nullable(),
5771
- email: z.string().describe("Login email").email().optional().nullable(),
5772
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
5916
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5917
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5918
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5773
5919
  emailVerificationRequired: z.boolean().describe(
5774
- "Indicates whether the member is required to verify their email"
5920
+ "Whether the member is required to verify their email before they can log in."
5775
5921
  ).optional().nullable(),
5776
5922
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
5777
5923
  profileInfo: z.object({
5778
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
5924
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5779
5925
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
5780
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
5781
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
5782
- photo: z.string().describe("Profile photo").optional()
5783
- }).describe("Profile info").optional(),
5926
+ reported: z.boolean().describe(
5927
+ "Whether the member has been reported by another member."
5928
+ ).optional().nullable(),
5929
+ muted: z.boolean().describe(
5930
+ "Whether the member has been muted and can't post or comment on the site."
5931
+ ).optional().nullable(),
5932
+ photo: z.string().describe("Member's profile photo.").optional()
5933
+ }).describe("Information about the member's public profile.").optional(),
5784
5934
  userInfo: z.object({
5785
- userId: z.string().describe("User ID").regex(
5935
+ userId: z.string().describe("User ID.").regex(
5786
5936
  /^[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}$/,
5787
5937
  "Must be a valid GUID"
5788
5938
  ).optional(),
5789
5939
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
5790
- }).describe("User info").optional(),
5940
+ }).describe("Information about the member's user account.").optional(),
5791
5941
  sessionInfo: z.object({
5792
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5942
+ lastWebLogin: z.date().describe(
5943
+ "Date and time the member last logged in to the site from a browser."
5944
+ ).optional().nullable(),
5793
5945
  lastMobileLogin: z.date().describe(
5794
- "Last time the member logged in to one of the mobile apps"
5946
+ "Date and time the member last logged in from one of the mobile apps."
5795
5947
  ).optional().nullable(),
5796
5948
  mobileAppNames: z.array(z.string()).max(50).optional()
5797
- }).describe("Session info").optional(),
5949
+ }).describe("Information about the member's login sessions.").optional(),
5798
5950
  groupInfo: z.object({
5799
5951
  groupIds: z.array(z.string()).max(1e3).optional()
5800
- }).describe("Group info").optional()
5952
+ }).describe(
5953
+ "Information about the groups the member belongs to."
5954
+ ).optional()
5801
5955
  }).describe(
5802
5956
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
5803
5957
  ).optional(),
@@ -6042,43 +6196,53 @@ var BulkUpdateContactsResponse = z.object({
6042
6196
  ).optional(),
6043
6197
  segmentIds: z.array(z.string()).max(60).optional(),
6044
6198
  memberInfo: z.object({
6045
- memberId: z.string().describe("Member ID").regex(
6199
+ memberId: z.string().describe("Member ID.").regex(
6046
6200
  /^[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}$/,
6047
6201
  "Must be a valid GUID"
6048
6202
  ).optional().nullable(),
6049
- signupDate: z.date().describe("Signup date").optional().nullable(),
6050
- email: z.string().describe("Login email").email().optional().nullable(),
6051
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
6203
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6204
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6205
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6052
6206
  emailVerificationRequired: z.boolean().describe(
6053
- "Indicates whether the member is required to verify their email"
6207
+ "Whether the member is required to verify their email before they can log in."
6054
6208
  ).optional().nullable(),
6055
6209
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
6056
- "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."
6210
+ "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."
6057
6211
  ).optional(),
6058
6212
  profileInfo: z.object({
6059
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
6060
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
6061
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
6062
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
6063
- photo: z.string().describe("Profile photo").optional()
6064
- }).describe("Profile info").optional(),
6213
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6214
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
6215
+ "Whether the member's profile is visible to other site members and visitors."
6216
+ ).optional(),
6217
+ reported: z.boolean().describe(
6218
+ "Whether the member has been reported by another member."
6219
+ ).optional().nullable(),
6220
+ muted: z.boolean().describe(
6221
+ "Whether the member has been muted and can't post or comment on the site."
6222
+ ).optional().nullable(),
6223
+ photo: z.string().describe("Member's profile photo.").optional()
6224
+ }).describe("Information about the member's public profile.").optional(),
6065
6225
  userInfo: z.object({
6066
- userId: z.string().describe("User ID").regex(
6226
+ userId: z.string().describe("User ID.").regex(
6067
6227
  /^[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}$/,
6068
6228
  "Must be a valid GUID"
6069
6229
  ).optional(),
6070
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6071
- }).describe("User info").optional(),
6230
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
6231
+ }).describe("Information about the member's user account.").optional(),
6072
6232
  sessionInfo: z.object({
6073
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6233
+ lastWebLogin: z.date().describe(
6234
+ "Date and time the member last logged in to the site from a browser."
6235
+ ).optional().nullable(),
6074
6236
  lastMobileLogin: z.date().describe(
6075
- "Last time the member logged in to one of the mobile apps"
6237
+ "Date and time the member last logged in from one of the mobile apps."
6076
6238
  ).optional().nullable(),
6077
6239
  mobileAppNames: z.array(z.string()).max(50).optional()
6078
- }).describe("Session info").optional(),
6240
+ }).describe("Information about the member's login sessions.").optional(),
6079
6241
  groupInfo: z.object({
6080
6242
  groupIds: z.array(z.string()).max(1e3).optional()
6081
- }).describe("Group info").optional()
6243
+ }).describe(
6244
+ "Information about the groups the member belongs to."
6245
+ ).optional()
6082
6246
  }).describe(
6083
6247
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
6084
6248
  ).optional(),
@@ -6342,43 +6506,53 @@ var BulkUpdateContactTagsResponse = z.object({
6342
6506
  ).optional(),
6343
6507
  segmentIds: z.array(z.string()).max(60).optional(),
6344
6508
  memberInfo: z.object({
6345
- memberId: z.string().describe("Member ID").regex(
6509
+ memberId: z.string().describe("Member ID.").regex(
6346
6510
  /^[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}$/,
6347
6511
  "Must be a valid GUID"
6348
6512
  ).optional().nullable(),
6349
- signupDate: z.date().describe("Signup date").optional().nullable(),
6350
- email: z.string().describe("Login email").email().optional().nullable(),
6351
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
6513
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6514
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6515
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6352
6516
  emailVerificationRequired: z.boolean().describe(
6353
- "Indicates whether the member is required to verify their email"
6517
+ "Whether the member is required to verify their email before they can log in."
6354
6518
  ).optional().nullable(),
6355
6519
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
6356
- "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."
6520
+ "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."
6357
6521
  ).optional(),
6358
6522
  profileInfo: z.object({
6359
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
6360
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
6361
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
6362
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
6363
- photo: z.string().describe("Profile photo").optional()
6364
- }).describe("Profile info").optional(),
6523
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6524
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
6525
+ "Whether the member's profile is visible to other site members and visitors."
6526
+ ).optional(),
6527
+ reported: z.boolean().describe(
6528
+ "Whether the member has been reported by another member."
6529
+ ).optional().nullable(),
6530
+ muted: z.boolean().describe(
6531
+ "Whether the member has been muted and can't post or comment on the site."
6532
+ ).optional().nullable(),
6533
+ photo: z.string().describe("Member's profile photo.").optional()
6534
+ }).describe("Information about the member's public profile.").optional(),
6365
6535
  userInfo: z.object({
6366
- userId: z.string().describe("User ID").regex(
6536
+ userId: z.string().describe("User ID.").regex(
6367
6537
  /^[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}$/,
6368
6538
  "Must be a valid GUID"
6369
6539
  ).optional(),
6370
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6371
- }).describe("User info").optional(),
6540
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
6541
+ }).describe("Information about the member's user account.").optional(),
6372
6542
  sessionInfo: z.object({
6373
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6543
+ lastWebLogin: z.date().describe(
6544
+ "Date and time the member last logged in to the site from a browser."
6545
+ ).optional().nullable(),
6374
6546
  lastMobileLogin: z.date().describe(
6375
- "Last time the member logged in to one of the mobile apps"
6547
+ "Date and time the member last logged in from one of the mobile apps."
6376
6548
  ).optional().nullable(),
6377
6549
  mobileAppNames: z.array(z.string()).max(50).optional()
6378
- }).describe("Session info").optional(),
6550
+ }).describe("Information about the member's login sessions.").optional(),
6379
6551
  groupInfo: z.object({
6380
6552
  groupIds: z.array(z.string()).max(1e3).optional()
6381
- }).describe("Group info").optional()
6553
+ }).describe(
6554
+ "Information about the groups the member belongs to."
6555
+ ).optional()
6382
6556
  }).describe(
6383
6557
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
6384
6558
  ).optional(),
@@ -6624,41 +6798,49 @@ var BulkUpsertContactsRequest = z.object({
6624
6798
  ).optional(),
6625
6799
  segmentIds: z.array(z.string()).max(60).optional(),
6626
6800
  memberInfo: z.object({
6627
- memberId: z.string().describe("Member ID").regex(
6801
+ memberId: z.string().describe("Member ID.").regex(
6628
6802
  /^[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}$/,
6629
6803
  "Must be a valid GUID"
6630
6804
  ).optional().nullable(),
6631
- signupDate: z.date().describe("Signup date").optional().nullable(),
6632
- email: z.string().describe("Login email").email().optional().nullable(),
6633
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
6805
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6806
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6807
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6634
6808
  emailVerificationRequired: z.boolean().describe(
6635
- "Indicates whether the member is required to verify their email"
6809
+ "Whether the member is required to verify their email before they can log in."
6636
6810
  ).optional().nullable(),
6637
6811
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
6638
6812
  profileInfo: z.object({
6639
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
6813
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6640
6814
  privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).optional(),
6641
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
6642
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
6643
- photo: z.string().describe("Profile photo").optional()
6644
- }).describe("Profile info").optional(),
6815
+ reported: z.boolean().describe(
6816
+ "Whether the member has been reported by another member."
6817
+ ).optional().nullable(),
6818
+ muted: z.boolean().describe(
6819
+ "Whether the member has been muted and can't post or comment on the site."
6820
+ ).optional().nullable(),
6821
+ photo: z.string().describe("Member's profile photo.").optional()
6822
+ }).describe("Information about the member's public profile.").optional(),
6645
6823
  userInfo: z.object({
6646
- userId: z.string().describe("User ID").regex(
6824
+ userId: z.string().describe("User ID.").regex(
6647
6825
  /^[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}$/,
6648
6826
  "Must be a valid GUID"
6649
6827
  ).optional(),
6650
6828
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
6651
- }).describe("User info").optional(),
6829
+ }).describe("Information about the member's user account.").optional(),
6652
6830
  sessionInfo: z.object({
6653
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6831
+ lastWebLogin: z.date().describe(
6832
+ "Date and time the member last logged in to the site from a browser."
6833
+ ).optional().nullable(),
6654
6834
  lastMobileLogin: z.date().describe(
6655
- "Last time the member logged in to one of the mobile apps"
6835
+ "Date and time the member last logged in from one of the mobile apps."
6656
6836
  ).optional().nullable(),
6657
6837
  mobileAppNames: z.array(z.string()).max(50).optional()
6658
- }).describe("Session info").optional(),
6838
+ }).describe("Information about the member's login sessions.").optional(),
6659
6839
  groupInfo: z.object({
6660
6840
  groupIds: z.array(z.string()).max(1e3).optional()
6661
- }).describe("Group info").optional()
6841
+ }).describe(
6842
+ "Information about the groups the member belongs to."
6843
+ ).optional()
6662
6844
  }).describe(
6663
6845
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
6664
6846
  ).optional(),
@@ -6904,43 +7086,53 @@ var BulkUpsertContactsResponse = z.object({
6904
7086
  ).optional(),
6905
7087
  segmentIds: z.array(z.string()).max(60).optional(),
6906
7088
  memberInfo: z.object({
6907
- memberId: z.string().describe("Member ID").regex(
7089
+ memberId: z.string().describe("Member ID.").regex(
6908
7090
  /^[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}$/,
6909
7091
  "Must be a valid GUID"
6910
7092
  ).optional().nullable(),
6911
- signupDate: z.date().describe("Signup date").optional().nullable(),
6912
- email: z.string().describe("Login email").email().optional().nullable(),
6913
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
7093
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7094
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7095
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6914
7096
  emailVerificationRequired: z.boolean().describe(
6915
- "Indicates whether the member is required to verify their email"
7097
+ "Whether the member is required to verify their email before they can log in."
6916
7098
  ).optional().nullable(),
6917
7099
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
6918
- "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."
7100
+ "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."
6919
7101
  ).optional(),
6920
7102
  profileInfo: z.object({
6921
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
6922
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
6923
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
6924
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
6925
- photo: z.string().describe("Profile photo").optional()
6926
- }).describe("Profile info").optional(),
7103
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7104
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7105
+ "Whether the member's profile is visible to other site members and visitors."
7106
+ ).optional(),
7107
+ reported: z.boolean().describe(
7108
+ "Whether the member has been reported by another member."
7109
+ ).optional().nullable(),
7110
+ muted: z.boolean().describe(
7111
+ "Whether the member has been muted and can't post or comment on the site."
7112
+ ).optional().nullable(),
7113
+ photo: z.string().describe("Member's profile photo.").optional()
7114
+ }).describe("Information about the member's public profile.").optional(),
6927
7115
  userInfo: z.object({
6928
- userId: z.string().describe("User ID").regex(
7116
+ userId: z.string().describe("User ID.").regex(
6929
7117
  /^[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}$/,
6930
7118
  "Must be a valid GUID"
6931
7119
  ).optional(),
6932
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6933
- }).describe("User info").optional(),
7120
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7121
+ }).describe("Information about the member's user account.").optional(),
6934
7122
  sessionInfo: z.object({
6935
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7123
+ lastWebLogin: z.date().describe(
7124
+ "Date and time the member last logged in to the site from a browser."
7125
+ ).optional().nullable(),
6936
7126
  lastMobileLogin: z.date().describe(
6937
- "Last time the member logged in to one of the mobile apps"
7127
+ "Date and time the member last logged in from one of the mobile apps."
6938
7128
  ).optional().nullable(),
6939
7129
  mobileAppNames: z.array(z.string()).max(50).optional()
6940
- }).describe("Session info").optional(),
7130
+ }).describe("Information about the member's login sessions.").optional(),
6941
7131
  groupInfo: z.object({
6942
7132
  groupIds: z.array(z.string()).max(1e3).optional()
6943
- }).describe("Group info").optional()
7133
+ }).describe(
7134
+ "Information about the groups the member belongs to."
7135
+ ).optional()
6944
7136
  }).describe(
6945
7137
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
6946
7138
  ).optional(),
@@ -7235,41 +7427,49 @@ var RestoreContactFromTrashBinResponse = z.object({
7235
7427
  ).optional(),
7236
7428
  segmentIds: z.array(z.string()).max(60).optional(),
7237
7429
  memberInfo: z.object({
7238
- memberId: z.string().describe("Member ID").regex(
7430
+ memberId: z.string().describe("Member ID.").regex(
7239
7431
  /^[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}$/,
7240
7432
  "Must be a valid GUID"
7241
7433
  ).optional().nullable(),
7242
- signupDate: z.date().describe("Signup date").optional().nullable(),
7243
- email: z.string().describe("Login email").email().optional().nullable(),
7244
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
7434
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7435
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7436
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7245
7437
  emailVerificationRequired: z.boolean().describe(
7246
- "Indicates whether the member is required to verify their email"
7438
+ "Whether the member is required to verify their email before they can log in."
7247
7439
  ).optional().nullable(),
7248
7440
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
7249
- "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."
7441
+ "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."
7250
7442
  ).optional(),
7251
7443
  profileInfo: z.object({
7252
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
7253
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
7254
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
7255
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
7256
- photo: z.string().describe("Profile photo").optional()
7257
- }).describe("Profile info").optional(),
7444
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7445
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7446
+ "Whether the member's profile is visible to other site members and visitors."
7447
+ ).optional(),
7448
+ reported: z.boolean().describe(
7449
+ "Whether the member has been reported by another member."
7450
+ ).optional().nullable(),
7451
+ muted: z.boolean().describe(
7452
+ "Whether the member has been muted and can't post or comment on the site."
7453
+ ).optional().nullable(),
7454
+ photo: z.string().describe("Member's profile photo.").optional()
7455
+ }).describe("Information about the member's public profile.").optional(),
7258
7456
  userInfo: z.object({
7259
- userId: z.string().describe("User ID").regex(
7457
+ userId: z.string().describe("User ID.").regex(
7260
7458
  /^[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}$/,
7261
7459
  "Must be a valid GUID"
7262
7460
  ).optional(),
7263
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7264
- }).describe("User info").optional(),
7461
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7462
+ }).describe("Information about the member's user account.").optional(),
7265
7463
  sessionInfo: z.object({
7266
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7464
+ lastWebLogin: z.date().describe(
7465
+ "Date and time the member last logged in to the site from a browser."
7466
+ ).optional().nullable(),
7267
7467
  lastMobileLogin: z.date().describe(
7268
- "Last time the member logged in to one of the mobile apps"
7468
+ "Date and time the member last logged in from one of the mobile apps."
7269
7469
  ).optional().nullable(),
7270
7470
  mobileAppNames: z.array(z.string()).max(50).optional()
7271
- }).describe("Session info").optional(),
7272
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
7471
+ }).describe("Information about the member's login sessions.").optional(),
7472
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
7273
7473
  }).describe(
7274
7474
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
7275
7475
  ).optional(),
@@ -7510,43 +7710,53 @@ var BulkRestoreContactsFromTrashBinResponse = z.object({
7510
7710
  ).optional(),
7511
7711
  segmentIds: z.array(z.string()).max(60).optional(),
7512
7712
  memberInfo: z.object({
7513
- memberId: z.string().describe("Member ID").regex(
7713
+ memberId: z.string().describe("Member ID.").regex(
7514
7714
  /^[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}$/,
7515
7715
  "Must be a valid GUID"
7516
7716
  ).optional().nullable(),
7517
- signupDate: z.date().describe("Signup date").optional().nullable(),
7518
- email: z.string().describe("Login email").email().optional().nullable(),
7519
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
7717
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7718
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7719
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7520
7720
  emailVerificationRequired: z.boolean().describe(
7521
- "Indicates whether the member is required to verify their email"
7721
+ "Whether the member is required to verify their email before they can log in."
7522
7722
  ).optional().nullable(),
7523
7723
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
7524
- "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."
7724
+ "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."
7525
7725
  ).optional(),
7526
7726
  profileInfo: z.object({
7527
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
7528
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
7529
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
7530
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
7531
- photo: z.string().describe("Profile photo").optional()
7532
- }).describe("Profile info").optional(),
7727
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7728
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7729
+ "Whether the member's profile is visible to other site members and visitors."
7730
+ ).optional(),
7731
+ reported: z.boolean().describe(
7732
+ "Whether the member has been reported by another member."
7733
+ ).optional().nullable(),
7734
+ muted: z.boolean().describe(
7735
+ "Whether the member has been muted and can't post or comment on the site."
7736
+ ).optional().nullable(),
7737
+ photo: z.string().describe("Member's profile photo.").optional()
7738
+ }).describe("Information about the member's public profile.").optional(),
7533
7739
  userInfo: z.object({
7534
- userId: z.string().describe("User ID").regex(
7740
+ userId: z.string().describe("User ID.").regex(
7535
7741
  /^[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}$/,
7536
7742
  "Must be a valid GUID"
7537
7743
  ).optional(),
7538
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7539
- }).describe("User info").optional(),
7744
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7745
+ }).describe("Information about the member's user account.").optional(),
7540
7746
  sessionInfo: z.object({
7541
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7747
+ lastWebLogin: z.date().describe(
7748
+ "Date and time the member last logged in to the site from a browser."
7749
+ ).optional().nullable(),
7542
7750
  lastMobileLogin: z.date().describe(
7543
- "Last time the member logged in to one of the mobile apps"
7751
+ "Date and time the member last logged in from one of the mobile apps."
7544
7752
  ).optional().nullable(),
7545
7753
  mobileAppNames: z.array(z.string()).max(50).optional()
7546
- }).describe("Session info").optional(),
7754
+ }).describe("Information about the member's login sessions.").optional(),
7547
7755
  groupInfo: z.object({
7548
7756
  groupIds: z.array(z.string()).max(1e3).optional()
7549
- }).describe("Group info").optional()
7757
+ }).describe(
7758
+ "Information about the groups the member belongs to."
7759
+ ).optional()
7550
7760
  }).describe(
7551
7761
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
7552
7762
  ).optional(),
@@ -7767,41 +7977,49 @@ var GetDeletedContactResponse = z.object({
7767
7977
  ).optional(),
7768
7978
  segmentIds: z.array(z.string()).max(60).optional(),
7769
7979
  memberInfo: z.object({
7770
- memberId: z.string().describe("Member ID").regex(
7980
+ memberId: z.string().describe("Member ID.").regex(
7771
7981
  /^[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}$/,
7772
7982
  "Must be a valid GUID"
7773
7983
  ).optional().nullable(),
7774
- signupDate: z.date().describe("Signup date").optional().nullable(),
7775
- email: z.string().describe("Login email").email().optional().nullable(),
7776
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
7984
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7985
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7986
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7777
7987
  emailVerificationRequired: z.boolean().describe(
7778
- "Indicates whether the member is required to verify their email"
7988
+ "Whether the member is required to verify their email before they can log in."
7779
7989
  ).optional().nullable(),
7780
7990
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
7781
- "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."
7991
+ "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."
7782
7992
  ).optional(),
7783
7993
  profileInfo: z.object({
7784
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
7785
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
7786
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
7787
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
7788
- photo: z.string().describe("Profile photo").optional()
7789
- }).describe("Profile info").optional(),
7994
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7995
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7996
+ "Whether the member's profile is visible to other site members and visitors."
7997
+ ).optional(),
7998
+ reported: z.boolean().describe(
7999
+ "Whether the member has been reported by another member."
8000
+ ).optional().nullable(),
8001
+ muted: z.boolean().describe(
8002
+ "Whether the member has been muted and can't post or comment on the site."
8003
+ ).optional().nullable(),
8004
+ photo: z.string().describe("Member's profile photo.").optional()
8005
+ }).describe("Information about the member's public profile.").optional(),
7790
8006
  userInfo: z.object({
7791
- userId: z.string().describe("User ID").regex(
8007
+ userId: z.string().describe("User ID.").regex(
7792
8008
  /^[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}$/,
7793
8009
  "Must be a valid GUID"
7794
8010
  ).optional(),
7795
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7796
- }).describe("User info").optional(),
8011
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
8012
+ }).describe("Information about the member's user account.").optional(),
7797
8013
  sessionInfo: z.object({
7798
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
8014
+ lastWebLogin: z.date().describe(
8015
+ "Date and time the member last logged in to the site from a browser."
8016
+ ).optional().nullable(),
7799
8017
  lastMobileLogin: z.date().describe(
7800
- "Last time the member logged in to one of the mobile apps"
8018
+ "Date and time the member last logged in from one of the mobile apps."
7801
8019
  ).optional().nullable(),
7802
8020
  mobileAppNames: z.array(z.string()).max(50).optional()
7803
- }).describe("Session info").optional(),
7804
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
8021
+ }).describe("Information about the member's login sessions.").optional(),
8022
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
7805
8023
  }).describe(
7806
8024
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
7807
8025
  ).optional(),
@@ -8028,41 +8246,49 @@ var ListDeletedContactsResponse = z.object({
8028
8246
  ).optional(),
8029
8247
  segmentIds: z.array(z.string()).max(60).optional(),
8030
8248
  memberInfo: z.object({
8031
- memberId: z.string().describe("Member ID").regex(
8249
+ memberId: z.string().describe("Member ID.").regex(
8032
8250
  /^[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}$/,
8033
8251
  "Must be a valid GUID"
8034
8252
  ).optional().nullable(),
8035
- signupDate: z.date().describe("Signup date").optional().nullable(),
8036
- email: z.string().describe("Login email").email().optional().nullable(),
8037
- emailVerified: z.boolean().describe("Indicate whether the email is verified").optional().nullable(),
8253
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
8254
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
8255
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
8038
8256
  emailVerificationRequired: z.boolean().describe(
8039
- "Indicates whether the member is required to verify their email"
8257
+ "Whether the member is required to verify their email before they can log in."
8040
8258
  ).optional().nullable(),
8041
8259
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).describe(
8042
- "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."
8260
+ "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."
8043
8261
  ).optional(),
8044
8262
  profileInfo: z.object({
8045
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
8046
- privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe("Privacy status").optional(),
8047
- reported: z.boolean().describe("Indicate whether the member is reported").optional().nullable(),
8048
- muted: z.boolean().describe("Indicate whether the member is muted").optional().nullable(),
8049
- photo: z.string().describe("Profile photo").optional()
8050
- }).describe("Profile info").optional(),
8263
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
8264
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
8265
+ "Whether the member's profile is visible to other site members and visitors."
8266
+ ).optional(),
8267
+ reported: z.boolean().describe(
8268
+ "Whether the member has been reported by another member."
8269
+ ).optional().nullable(),
8270
+ muted: z.boolean().describe(
8271
+ "Whether the member has been muted and can't post or comment on the site."
8272
+ ).optional().nullable(),
8273
+ photo: z.string().describe("Member's profile photo.").optional()
8274
+ }).describe("Information about the member's public profile.").optional(),
8051
8275
  userInfo: z.object({
8052
- userId: z.string().describe("User ID").regex(
8276
+ userId: z.string().describe("User ID.").regex(
8053
8277
  /^[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}$/,
8054
8278
  "Must be a valid GUID"
8055
8279
  ).optional(),
8056
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
8057
- }).describe("User info").optional(),
8280
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
8281
+ }).describe("Information about the member's user account.").optional(),
8058
8282
  sessionInfo: z.object({
8059
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
8283
+ lastWebLogin: z.date().describe(
8284
+ "Date and time the member last logged in to the site from a browser."
8285
+ ).optional().nullable(),
8060
8286
  lastMobileLogin: z.date().describe(
8061
- "Last time the member logged in to one of the mobile apps"
8287
+ "Date and time the member last logged in from one of the mobile apps."
8062
8288
  ).optional().nullable(),
8063
8289
  mobileAppNames: z.array(z.string()).max(50).optional()
8064
- }).describe("Session info").optional(),
8065
- groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Group info").optional()
8290
+ }).describe("Information about the member's login sessions.").optional(),
8291
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
8066
8292
  }).describe(
8067
8293
  "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.\n\nUpdates are eventually consistent: changes to the underlying member, identity, or profile are reflected after the corresponding events are processed."
8068
8294
  ).optional(),