@wix/auto_sdk_crm_contacts-v-5 1.0.2 → 1.0.4

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-DARTxFF5.d.ts} +62 -48
  2. package/build/cjs/index.d.ts +16 -16
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +4 -4
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +43 -30
  7. package/build/cjs/meta.js.map +1 -1
  8. package/build/cjs/schemas.js +765 -545
  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-DARTxFF5.d.mts} +62 -48
  11. package/build/es/index.d.mts +16 -16
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +4 -4
  14. package/build/es/index.typings.mjs.map +1 -1
  15. package/build/es/meta.d.mts +43 -30
  16. package/build/es/meta.mjs.map +1 -1
  17. package/build/es/schemas.mjs +765 -545
  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-DARTxFF5.d.ts} +62 -48
  20. package/build/internal/cjs/index.d.ts +16 -16
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +4 -4
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +43 -30
  25. package/build/internal/cjs/meta.js.map +1 -1
  26. package/build/internal/cjs/schemas.js +765 -545
  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-DARTxFF5.d.mts} +62 -48
  29. package/build/internal/es/index.d.mts +16 -16
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +4 -4
  32. package/build/internal/es/index.typings.mjs.map +1 -1
  33. package/build/internal/es/meta.d.mts +43 -30
  34. package/build/internal/es/meta.mjs.map +1 -1
  35. package/build/internal/es/schemas.mjs +765 -545
  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(),
@@ -3730,7 +3820,9 @@ var CountContactsRequest = z.object({
3730
3820
  }).optional()
3731
3821
  });
3732
3822
  var CountContactsResponse = z.object({
3733
- count: z.number().int().describe("number of contacts").optional()
3823
+ count: z.number().int().describe(
3824
+ "Number of contacts that match the provided filter and search criteria."
3825
+ ).optional()
3734
3826
  });
3735
3827
  var GenerateContactImageUploadUrlRequest = z.object({
3736
3828
  contactId: z.string().describe("ID of the contact whose picture is being updated.").regex(
@@ -3739,7 +3831,7 @@ var GenerateContactImageUploadUrlRequest = z.object({
3739
3831
  ),
3740
3832
  options: z.object({
3741
3833
  mimeType: z.string().describe(
3742
- "Mime Type. Must be one of: `image/png`, `image/jpeg`.\nDefaults to `image/png`."
3834
+ "MIME type. Must be one of: `image/png`, `image/jpeg`.\n\nDefault: `image/png`"
3743
3835
  ).max(100).optional().nullable()
3744
3836
  }).optional()
3745
3837
  });
@@ -3948,41 +4040,49 @@ var AddContactAdditionalEmailResponse = z.object({
3948
4040
  ).optional(),
3949
4041
  segmentIds: z.array(z.string()).max(60).optional(),
3950
4042
  memberInfo: z.object({
3951
- memberId: z.string().describe("Member ID").regex(
4043
+ memberId: z.string().describe("Member ID.").regex(
3952
4044
  /^[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
4045
  "Must be a valid GUID"
3954
4046
  ).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(),
4047
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4048
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4049
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
3958
4050
  emailVerificationRequired: z.boolean().describe(
3959
- "Indicates whether the member is required to verify their email"
4051
+ "Whether the member is required to verify their email before they can log in."
3960
4052
  ).optional().nullable(),
3961
4053
  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."
4054
+ "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
4055
  ).optional(),
3964
4056
  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(),
4057
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4058
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4059
+ "Whether the member's profile is visible to other site members and visitors."
4060
+ ).optional(),
4061
+ reported: z.boolean().describe(
4062
+ "Whether the member has been reported by another member."
4063
+ ).optional().nullable(),
4064
+ muted: z.boolean().describe(
4065
+ "Whether the member has been muted and can't post or comment on the site."
4066
+ ).optional().nullable(),
4067
+ photo: z.string().describe("Member's profile photo.").optional()
4068
+ }).describe("Information about the member's public profile.").optional(),
3971
4069
  userInfo: z.object({
3972
- userId: z.string().describe("User ID").regex(
4070
+ userId: z.string().describe("User ID.").regex(
3973
4071
  /^[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
4072
  "Must be a valid GUID"
3975
4073
  ).optional(),
3976
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
3977
- }).describe("User info").optional(),
4074
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4075
+ }).describe("Information about the member's user account.").optional(),
3978
4076
  sessionInfo: z.object({
3979
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4077
+ lastWebLogin: z.date().describe(
4078
+ "Date and time the member last logged in to the site from a browser."
4079
+ ).optional().nullable(),
3980
4080
  lastMobileLogin: z.date().describe(
3981
- "Last time the member logged in to one of the mobile apps"
4081
+ "Date and time the member last logged in from one of the mobile apps."
3982
4082
  ).optional().nullable(),
3983
4083
  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()
4084
+ }).describe("Information about the member's login sessions.").optional(),
4085
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
3986
4086
  }).describe(
3987
4087
  "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
4088
  ).optional(),
@@ -4204,41 +4304,49 @@ var AddContactAdditionalPhoneResponse = z.object({
4204
4304
  ).optional(),
4205
4305
  segmentIds: z.array(z.string()).max(60).optional(),
4206
4306
  memberInfo: z.object({
4207
- memberId: z.string().describe("Member ID").regex(
4307
+ memberId: z.string().describe("Member ID.").regex(
4208
4308
  /^[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
4309
  "Must be a valid GUID"
4210
4310
  ).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(),
4311
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4312
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4313
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4214
4314
  emailVerificationRequired: z.boolean().describe(
4215
- "Indicates whether the member is required to verify their email"
4315
+ "Whether the member is required to verify their email before they can log in."
4216
4316
  ).optional().nullable(),
4217
4317
  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."
4318
+ "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
4319
  ).optional(),
4220
4320
  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(),
4321
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4322
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4323
+ "Whether the member's profile is visible to other site members and visitors."
4324
+ ).optional(),
4325
+ reported: z.boolean().describe(
4326
+ "Whether the member has been reported by another member."
4327
+ ).optional().nullable(),
4328
+ muted: z.boolean().describe(
4329
+ "Whether the member has been muted and can't post or comment on the site."
4330
+ ).optional().nullable(),
4331
+ photo: z.string().describe("Member's profile photo.").optional()
4332
+ }).describe("Information about the member's public profile.").optional(),
4227
4333
  userInfo: z.object({
4228
- userId: z.string().describe("User ID").regex(
4334
+ userId: z.string().describe("User ID.").regex(
4229
4335
  /^[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
4336
  "Must be a valid GUID"
4231
4337
  ).optional(),
4232
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4233
- }).describe("User info").optional(),
4338
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4339
+ }).describe("Information about the member's user account.").optional(),
4234
4340
  sessionInfo: z.object({
4235
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4341
+ lastWebLogin: z.date().describe(
4342
+ "Date and time the member last logged in to the site from a browser."
4343
+ ).optional().nullable(),
4236
4344
  lastMobileLogin: z.date().describe(
4237
- "Last time the member logged in to one of the mobile apps"
4345
+ "Date and time the member last logged in from one of the mobile apps."
4238
4346
  ).optional().nullable(),
4239
4347
  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()
4348
+ }).describe("Information about the member's login sessions.").optional(),
4349
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4242
4350
  }).describe(
4243
4351
  "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
4352
  ).optional(),
@@ -4477,41 +4585,49 @@ var AddContactAddressResponse = z.object({
4477
4585
  ).optional(),
4478
4586
  segmentIds: z.array(z.string()).max(60).optional(),
4479
4587
  memberInfo: z.object({
4480
- memberId: z.string().describe("Member ID").regex(
4588
+ memberId: z.string().describe("Member ID.").regex(
4481
4589
  /^[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
4590
  "Must be a valid GUID"
4483
4591
  ).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(),
4592
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4593
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4594
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4487
4595
  emailVerificationRequired: z.boolean().describe(
4488
- "Indicates whether the member is required to verify their email"
4596
+ "Whether the member is required to verify their email before they can log in."
4489
4597
  ).optional().nullable(),
4490
4598
  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."
4599
+ "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
4600
  ).optional(),
4493
4601
  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(),
4602
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4603
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4604
+ "Whether the member's profile is visible to other site members and visitors."
4605
+ ).optional(),
4606
+ reported: z.boolean().describe(
4607
+ "Whether the member has been reported by another member."
4608
+ ).optional().nullable(),
4609
+ muted: z.boolean().describe(
4610
+ "Whether the member has been muted and can't post or comment on the site."
4611
+ ).optional().nullable(),
4612
+ photo: z.string().describe("Member's profile photo.").optional()
4613
+ }).describe("Information about the member's public profile.").optional(),
4500
4614
  userInfo: z.object({
4501
- userId: z.string().describe("User ID").regex(
4615
+ userId: z.string().describe("User ID.").regex(
4502
4616
  /^[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
4617
  "Must be a valid GUID"
4504
4618
  ).optional(),
4505
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4506
- }).describe("User info").optional(),
4619
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4620
+ }).describe("Information about the member's user account.").optional(),
4507
4621
  sessionInfo: z.object({
4508
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4622
+ lastWebLogin: z.date().describe(
4623
+ "Date and time the member last logged in to the site from a browser."
4624
+ ).optional().nullable(),
4509
4625
  lastMobileLogin: z.date().describe(
4510
- "Last time the member logged in to one of the mobile apps"
4626
+ "Date and time the member last logged in from one of the mobile apps."
4511
4627
  ).optional().nullable(),
4512
4628
  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()
4629
+ }).describe("Information about the member's login sessions.").optional(),
4630
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4515
4631
  }).describe(
4516
4632
  "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
4633
  ).optional(),
@@ -4728,41 +4844,49 @@ var DeleteContactAddressResponse = z.object({
4728
4844
  ).optional(),
4729
4845
  segmentIds: z.array(z.string()).max(60).optional(),
4730
4846
  memberInfo: z.object({
4731
- memberId: z.string().describe("Member ID").regex(
4847
+ memberId: z.string().describe("Member ID.").regex(
4732
4848
  /^[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
4849
  "Must be a valid GUID"
4734
4850
  ).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(),
4851
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
4852
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
4853
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
4738
4854
  emailVerificationRequired: z.boolean().describe(
4739
- "Indicates whether the member is required to verify their email"
4855
+ "Whether the member is required to verify their email before they can log in."
4740
4856
  ).optional().nullable(),
4741
4857
  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."
4858
+ "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
4859
  ).optional(),
4744
4860
  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(),
4861
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
4862
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
4863
+ "Whether the member's profile is visible to other site members and visitors."
4864
+ ).optional(),
4865
+ reported: z.boolean().describe(
4866
+ "Whether the member has been reported by another member."
4867
+ ).optional().nullable(),
4868
+ muted: z.boolean().describe(
4869
+ "Whether the member has been muted and can't post or comment on the site."
4870
+ ).optional().nullable(),
4871
+ photo: z.string().describe("Member's profile photo.").optional()
4872
+ }).describe("Information about the member's public profile.").optional(),
4751
4873
  userInfo: z.object({
4752
- userId: z.string().describe("User ID").regex(
4874
+ userId: z.string().describe("User ID.").regex(
4753
4875
  /^[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
4876
  "Must be a valid GUID"
4755
4877
  ).optional(),
4756
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
4757
- }).describe("User info").optional(),
4878
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
4879
+ }).describe("Information about the member's user account.").optional(),
4758
4880
  sessionInfo: z.object({
4759
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
4881
+ lastWebLogin: z.date().describe(
4882
+ "Date and time the member last logged in to the site from a browser."
4883
+ ).optional().nullable(),
4760
4884
  lastMobileLogin: z.date().describe(
4761
- "Last time the member logged in to one of the mobile apps"
4885
+ "Date and time the member last logged in from one of the mobile apps."
4762
4886
  ).optional().nullable(),
4763
4887
  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()
4888
+ }).describe("Information about the member's login sessions.").optional(),
4889
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
4766
4890
  }).describe(
4767
4891
  "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
4892
  ).optional(),
@@ -5007,41 +5131,49 @@ var UpdateContactAddressResponse = z.object({
5007
5131
  ).optional(),
5008
5132
  segmentIds: z.array(z.string()).max(60).optional(),
5009
5133
  memberInfo: z.object({
5010
- memberId: z.string().describe("Member ID").regex(
5134
+ memberId: z.string().describe("Member ID.").regex(
5011
5135
  /^[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
5136
  "Must be a valid GUID"
5013
5137
  ).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(),
5138
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5139
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5140
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5017
5141
  emailVerificationRequired: z.boolean().describe(
5018
- "Indicates whether the member is required to verify their email"
5142
+ "Whether the member is required to verify their email before they can log in."
5019
5143
  ).optional().nullable(),
5020
5144
  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."
5145
+ "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
5146
  ).optional(),
5023
5147
  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(),
5148
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5149
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
5150
+ "Whether the member's profile is visible to other site members and visitors."
5151
+ ).optional(),
5152
+ reported: z.boolean().describe(
5153
+ "Whether the member has been reported by another member."
5154
+ ).optional().nullable(),
5155
+ muted: z.boolean().describe(
5156
+ "Whether the member has been muted and can't post or comment on the site."
5157
+ ).optional().nullable(),
5158
+ photo: z.string().describe("Member's profile photo.").optional()
5159
+ }).describe("Information about the member's public profile.").optional(),
5030
5160
  userInfo: z.object({
5031
- userId: z.string().describe("User ID").regex(
5161
+ userId: z.string().describe("User ID.").regex(
5032
5162
  /^[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
5163
  "Must be a valid GUID"
5034
5164
  ).optional(),
5035
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
5036
- }).describe("User info").optional(),
5165
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
5166
+ }).describe("Information about the member's user account.").optional(),
5037
5167
  sessionInfo: z.object({
5038
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5168
+ lastWebLogin: z.date().describe(
5169
+ "Date and time the member last logged in to the site from a browser."
5170
+ ).optional().nullable(),
5039
5171
  lastMobileLogin: z.date().describe(
5040
- "Last time the member logged in to one of the mobile apps"
5172
+ "Date and time the member last logged in from one of the mobile apps."
5041
5173
  ).optional().nullable(),
5042
5174
  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()
5175
+ }).describe("Information about the member's login sessions.").optional(),
5176
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
5045
5177
  }).describe(
5046
5178
  "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
5179
  ).optional(),
@@ -5238,39 +5370,45 @@ var BulkCreateContactsRequest = z.object({
5238
5370
  ).optional(),
5239
5371
  segmentIds: z.array(z.string()).max(60).optional(),
5240
5372
  memberInfo: z.object({
5241
- memberId: z.string().describe("Member ID").regex(
5373
+ memberId: z.string().describe("Member ID.").regex(
5242
5374
  /^[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
5375
  "Must be a valid GUID"
5244
5376
  ).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(),
5377
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
5378
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
5379
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
5248
5380
  emailVerificationRequired: z.boolean().describe(
5249
- "Indicates whether the member is required to verify their email"
5381
+ "Whether the member is required to verify their email before they can log in."
5250
5382
  ).optional().nullable(),
5251
5383
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
5252
5384
  profileInfo: z.object({
5253
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
5385
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
5254
5386
  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(),
5387
+ reported: z.boolean().describe(
5388
+ "Whether the member has been reported by another member."
5389
+ ).optional().nullable(),
5390
+ muted: z.boolean().describe(
5391
+ "Whether the member has been muted and can't post or comment on the site."
5392
+ ).optional().nullable(),
5393
+ photo: z.string().describe("Member's profile photo.").optional()
5394
+ }).describe("Information about the member's public profile.").optional(),
5259
5395
  userInfo: z.object({
5260
- userId: z.string().describe("User ID").regex(
5396
+ userId: z.string().describe("User ID.").regex(
5261
5397
  /^[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
5398
  "Must be a valid GUID"
5263
5399
  ).optional(),
5264
5400
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
5265
- }).describe("User info").optional(),
5401
+ }).describe("Information about the member's user account.").optional(),
5266
5402
  sessionInfo: z.object({
5267
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
5403
+ lastWebLogin: z.date().describe(
5404
+ "Date and time the member last logged in to the site from a browser."
5405
+ ).optional().nullable(),
5268
5406
  lastMobileLogin: z.date().describe(
5269
- "Last time the member logged in to one of the mobile apps"
5407
+ "Date and time the member last logged in from one of the mobile apps."
5270
5408
  ).optional().nullable(),
5271
5409
  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()
5410
+ }).describe("Information about the member's login sessions.").optional(),
5411
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
5274
5412
  }).describe(
5275
5413
  "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
5414
  ).optional(),
@@ -5291,9 +5429,7 @@ var BulkCreateContactsRequest = z.object({
5291
5429
  })
5292
5430
  ).min(1).max(100),
5293
5431
  options: z.object({
5294
- returnEntity: z.boolean().describe(
5295
- "set to `true` if you wish to receive back the created Contacts in the response"
5296
- ).optional(),
5432
+ returnEntity: z.boolean().describe("Whether to include the created contacts in the response.").optional(),
5297
5433
  allowDuplicates: z.boolean().describe(
5298
5434
  "Allows creating the contact even if a duplicate already exists."
5299
5435
  ).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(),
@@ -5819,9 +5973,7 @@ var BulkUpdateContactsRequest = z.object({
5819
5973
  })
5820
5974
  ).min(1).max(100),
5821
5975
  options: z.object({
5822
- returnEntity: z.boolean().describe(
5823
- "set to `true` if you wish to receive back the updated Contacts in the response"
5824
- ).optional(),
5976
+ returnEntity: z.boolean().describe("Whether to include the updated contacts in the response.").optional(),
5825
5977
  allowDuplicates: z.boolean().describe(
5826
5978
  "Allows updating the contact even if it becomes a duplicate of another contact."
5827
5979
  ).optional()
@@ -6042,43 +6194,53 @@ var BulkUpdateContactsResponse = z.object({
6042
6194
  ).optional(),
6043
6195
  segmentIds: z.array(z.string()).max(60).optional(),
6044
6196
  memberInfo: z.object({
6045
- memberId: z.string().describe("Member ID").regex(
6197
+ memberId: z.string().describe("Member ID.").regex(
6046
6198
  /^[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
6199
  "Must be a valid GUID"
6048
6200
  ).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(),
6201
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6202
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6203
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6052
6204
  emailVerificationRequired: z.boolean().describe(
6053
- "Indicates whether the member is required to verify their email"
6205
+ "Whether the member is required to verify their email before they can log in."
6054
6206
  ).optional().nullable(),
6055
6207
  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."
6208
+ "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
6209
  ).optional(),
6058
6210
  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(),
6211
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6212
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
6213
+ "Whether the member's profile is visible to other site members and visitors."
6214
+ ).optional(),
6215
+ reported: z.boolean().describe(
6216
+ "Whether the member has been reported by another member."
6217
+ ).optional().nullable(),
6218
+ muted: z.boolean().describe(
6219
+ "Whether the member has been muted and can't post or comment on the site."
6220
+ ).optional().nullable(),
6221
+ photo: z.string().describe("Member's profile photo.").optional()
6222
+ }).describe("Information about the member's public profile.").optional(),
6065
6223
  userInfo: z.object({
6066
- userId: z.string().describe("User ID").regex(
6224
+ userId: z.string().describe("User ID.").regex(
6067
6225
  /^[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
6226
  "Must be a valid GUID"
6069
6227
  ).optional(),
6070
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6071
- }).describe("User info").optional(),
6228
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
6229
+ }).describe("Information about the member's user account.").optional(),
6072
6230
  sessionInfo: z.object({
6073
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6231
+ lastWebLogin: z.date().describe(
6232
+ "Date and time the member last logged in to the site from a browser."
6233
+ ).optional().nullable(),
6074
6234
  lastMobileLogin: z.date().describe(
6075
- "Last time the member logged in to one of the mobile apps"
6235
+ "Date and time the member last logged in from one of the mobile apps."
6076
6236
  ).optional().nullable(),
6077
6237
  mobileAppNames: z.array(z.string()).max(50).optional()
6078
- }).describe("Session info").optional(),
6238
+ }).describe("Information about the member's login sessions.").optional(),
6079
6239
  groupInfo: z.object({
6080
6240
  groupIds: z.array(z.string()).max(1e3).optional()
6081
- }).describe("Group info").optional()
6241
+ }).describe(
6242
+ "Information about the groups the member belongs to."
6243
+ ).optional()
6082
6244
  }).describe(
6083
6245
  "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
6246
  ).optional(),
@@ -6112,9 +6274,7 @@ var BulkUpdateContactsResponse = z.object({
6112
6274
  var BulkUpdateContactTagsRequest = z.object({
6113
6275
  contactIds: z.array(z.string()).min(1).max(100),
6114
6276
  options: z.object({
6115
- returnEntity: z.boolean().describe(
6116
- "set to `true` if you wish to receive back the updated Contacts in the response"
6117
- ).optional(),
6277
+ returnEntity: z.boolean().describe("Whether to include the updated contacts in the response.").optional(),
6118
6278
  assignTags: z.object({
6119
6279
  privateTags: z.object({ tagIds: z.array(z.string()).max(1e3).optional() }).describe(
6120
6280
  "Tags that are exposed to anyone with access to the entity."
@@ -6342,43 +6502,53 @@ var BulkUpdateContactTagsResponse = z.object({
6342
6502
  ).optional(),
6343
6503
  segmentIds: z.array(z.string()).max(60).optional(),
6344
6504
  memberInfo: z.object({
6345
- memberId: z.string().describe("Member ID").regex(
6505
+ memberId: z.string().describe("Member ID.").regex(
6346
6506
  /^[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
6507
  "Must be a valid GUID"
6348
6508
  ).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(),
6509
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6510
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6511
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6352
6512
  emailVerificationRequired: z.boolean().describe(
6353
- "Indicates whether the member is required to verify their email"
6513
+ "Whether the member is required to verify their email before they can log in."
6354
6514
  ).optional().nullable(),
6355
6515
  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."
6516
+ "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
6517
  ).optional(),
6358
6518
  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(),
6519
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6520
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
6521
+ "Whether the member's profile is visible to other site members and visitors."
6522
+ ).optional(),
6523
+ reported: z.boolean().describe(
6524
+ "Whether the member has been reported by another member."
6525
+ ).optional().nullable(),
6526
+ muted: z.boolean().describe(
6527
+ "Whether the member has been muted and can't post or comment on the site."
6528
+ ).optional().nullable(),
6529
+ photo: z.string().describe("Member's profile photo.").optional()
6530
+ }).describe("Information about the member's public profile.").optional(),
6365
6531
  userInfo: z.object({
6366
- userId: z.string().describe("User ID").regex(
6532
+ userId: z.string().describe("User ID.").regex(
6367
6533
  /^[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
6534
  "Must be a valid GUID"
6369
6535
  ).optional(),
6370
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6371
- }).describe("User info").optional(),
6536
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
6537
+ }).describe("Information about the member's user account.").optional(),
6372
6538
  sessionInfo: z.object({
6373
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6539
+ lastWebLogin: z.date().describe(
6540
+ "Date and time the member last logged in to the site from a browser."
6541
+ ).optional().nullable(),
6374
6542
  lastMobileLogin: z.date().describe(
6375
- "Last time the member logged in to one of the mobile apps"
6543
+ "Date and time the member last logged in from one of the mobile apps."
6376
6544
  ).optional().nullable(),
6377
6545
  mobileAppNames: z.array(z.string()).max(50).optional()
6378
- }).describe("Session info").optional(),
6546
+ }).describe("Information about the member's login sessions.").optional(),
6379
6547
  groupInfo: z.object({
6380
6548
  groupIds: z.array(z.string()).max(1e3).optional()
6381
- }).describe("Group info").optional()
6549
+ }).describe(
6550
+ "Information about the groups the member belongs to."
6551
+ ).optional()
6382
6552
  }).describe(
6383
6553
  "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
6554
  ).optional(),
@@ -6624,41 +6794,49 @@ var BulkUpsertContactsRequest = z.object({
6624
6794
  ).optional(),
6625
6795
  segmentIds: z.array(z.string()).max(60).optional(),
6626
6796
  memberInfo: z.object({
6627
- memberId: z.string().describe("Member ID").regex(
6797
+ memberId: z.string().describe("Member ID.").regex(
6628
6798
  /^[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
6799
  "Must be a valid GUID"
6630
6800
  ).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(),
6801
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
6802
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
6803
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6634
6804
  emailVerificationRequired: z.boolean().describe(
6635
- "Indicates whether the member is required to verify their email"
6805
+ "Whether the member is required to verify their email before they can log in."
6636
6806
  ).optional().nullable(),
6637
6807
  status: z.enum(["PENDING", "ACTIVE", "BLOCKED", "OFFLINE"]).optional(),
6638
6808
  profileInfo: z.object({
6639
- nickname: z.string().describe("Nickname").max(255).optional().nullable(),
6809
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
6640
6810
  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(),
6811
+ reported: z.boolean().describe(
6812
+ "Whether the member has been reported by another member."
6813
+ ).optional().nullable(),
6814
+ muted: z.boolean().describe(
6815
+ "Whether the member has been muted and can't post or comment on the site."
6816
+ ).optional().nullable(),
6817
+ photo: z.string().describe("Member's profile photo.").optional()
6818
+ }).describe("Information about the member's public profile.").optional(),
6645
6819
  userInfo: z.object({
6646
- userId: z.string().describe("User ID").regex(
6820
+ userId: z.string().describe("User ID.").regex(
6647
6821
  /^[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
6822
  "Must be a valid GUID"
6649
6823
  ).optional(),
6650
6824
  role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).optional()
6651
- }).describe("User info").optional(),
6825
+ }).describe("Information about the member's user account.").optional(),
6652
6826
  sessionInfo: z.object({
6653
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
6827
+ lastWebLogin: z.date().describe(
6828
+ "Date and time the member last logged in to the site from a browser."
6829
+ ).optional().nullable(),
6654
6830
  lastMobileLogin: z.date().describe(
6655
- "Last time the member logged in to one of the mobile apps"
6831
+ "Date and time the member last logged in from one of the mobile apps."
6656
6832
  ).optional().nullable(),
6657
6833
  mobileAppNames: z.array(z.string()).max(50).optional()
6658
- }).describe("Session info").optional(),
6834
+ }).describe("Information about the member's login sessions.").optional(),
6659
6835
  groupInfo: z.object({
6660
6836
  groupIds: z.array(z.string()).max(1e3).optional()
6661
- }).describe("Group info").optional()
6837
+ }).describe(
6838
+ "Information about the groups the member belongs to."
6839
+ ).optional()
6662
6840
  }).describe(
6663
6841
  "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
6842
  ).optional(),
@@ -6680,9 +6858,7 @@ var BulkUpsertContactsRequest = z.object({
6680
6858
  })
6681
6859
  ).min(1).max(100),
6682
6860
  options: z.object({
6683
- returnEntity: z.boolean().describe(
6684
- "set to `true` if you wish to receive back the updated Contacts in the response"
6685
- ).optional(),
6861
+ returnEntity: z.boolean().describe("Whether to include the upserted contacts in the response.").optional(),
6686
6862
  upsertMode: z.enum(["OVERWRITE", "APPEND", "OVERWRITE_APPEND_ARRAYS"]).optional(),
6687
6863
  updateMember: z.boolean().describe(
6688
6864
  "Indicates whether to update a contact even if it is a site member."
@@ -6904,43 +7080,53 @@ var BulkUpsertContactsResponse = z.object({
6904
7080
  ).optional(),
6905
7081
  segmentIds: z.array(z.string()).max(60).optional(),
6906
7082
  memberInfo: z.object({
6907
- memberId: z.string().describe("Member ID").regex(
7083
+ memberId: z.string().describe("Member ID.").regex(
6908
7084
  /^[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
7085
  "Must be a valid GUID"
6910
7086
  ).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(),
7087
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7088
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7089
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
6914
7090
  emailVerificationRequired: z.boolean().describe(
6915
- "Indicates whether the member is required to verify their email"
7091
+ "Whether the member is required to verify their email before they can log in."
6916
7092
  ).optional().nullable(),
6917
7093
  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."
7094
+ "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
7095
  ).optional(),
6920
7096
  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(),
7097
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7098
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7099
+ "Whether the member's profile is visible to other site members and visitors."
7100
+ ).optional(),
7101
+ reported: z.boolean().describe(
7102
+ "Whether the member has been reported by another member."
7103
+ ).optional().nullable(),
7104
+ muted: z.boolean().describe(
7105
+ "Whether the member has been muted and can't post or comment on the site."
7106
+ ).optional().nullable(),
7107
+ photo: z.string().describe("Member's profile photo.").optional()
7108
+ }).describe("Information about the member's public profile.").optional(),
6927
7109
  userInfo: z.object({
6928
- userId: z.string().describe("User ID").regex(
7110
+ userId: z.string().describe("User ID.").regex(
6929
7111
  /^[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
7112
  "Must be a valid GUID"
6931
7113
  ).optional(),
6932
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
6933
- }).describe("User info").optional(),
7114
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7115
+ }).describe("Information about the member's user account.").optional(),
6934
7116
  sessionInfo: z.object({
6935
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7117
+ lastWebLogin: z.date().describe(
7118
+ "Date and time the member last logged in to the site from a browser."
7119
+ ).optional().nullable(),
6936
7120
  lastMobileLogin: z.date().describe(
6937
- "Last time the member logged in to one of the mobile apps"
7121
+ "Date and time the member last logged in from one of the mobile apps."
6938
7122
  ).optional().nullable(),
6939
7123
  mobileAppNames: z.array(z.string()).max(50).optional()
6940
- }).describe("Session info").optional(),
7124
+ }).describe("Information about the member's login sessions.").optional(),
6941
7125
  groupInfo: z.object({
6942
7126
  groupIds: z.array(z.string()).max(1e3).optional()
6943
- }).describe("Group info").optional()
7127
+ }).describe(
7128
+ "Information about the groups the member belongs to."
7129
+ ).optional()
6944
7130
  }).describe(
6945
7131
  "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
7132
  ).optional(),
@@ -7235,41 +7421,49 @@ var RestoreContactFromTrashBinResponse = z.object({
7235
7421
  ).optional(),
7236
7422
  segmentIds: z.array(z.string()).max(60).optional(),
7237
7423
  memberInfo: z.object({
7238
- memberId: z.string().describe("Member ID").regex(
7424
+ memberId: z.string().describe("Member ID.").regex(
7239
7425
  /^[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
7426
  "Must be a valid GUID"
7241
7427
  ).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(),
7428
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7429
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7430
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7245
7431
  emailVerificationRequired: z.boolean().describe(
7246
- "Indicates whether the member is required to verify their email"
7432
+ "Whether the member is required to verify their email before they can log in."
7247
7433
  ).optional().nullable(),
7248
7434
  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."
7435
+ "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
7436
  ).optional(),
7251
7437
  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(),
7438
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7439
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7440
+ "Whether the member's profile is visible to other site members and visitors."
7441
+ ).optional(),
7442
+ reported: z.boolean().describe(
7443
+ "Whether the member has been reported by another member."
7444
+ ).optional().nullable(),
7445
+ muted: z.boolean().describe(
7446
+ "Whether the member has been muted and can't post or comment on the site."
7447
+ ).optional().nullable(),
7448
+ photo: z.string().describe("Member's profile photo.").optional()
7449
+ }).describe("Information about the member's public profile.").optional(),
7258
7450
  userInfo: z.object({
7259
- userId: z.string().describe("User ID").regex(
7451
+ userId: z.string().describe("User ID.").regex(
7260
7452
  /^[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
7453
  "Must be a valid GUID"
7262
7454
  ).optional(),
7263
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7264
- }).describe("User info").optional(),
7455
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7456
+ }).describe("Information about the member's user account.").optional(),
7265
7457
  sessionInfo: z.object({
7266
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7458
+ lastWebLogin: z.date().describe(
7459
+ "Date and time the member last logged in to the site from a browser."
7460
+ ).optional().nullable(),
7267
7461
  lastMobileLogin: z.date().describe(
7268
- "Last time the member logged in to one of the mobile apps"
7462
+ "Date and time the member last logged in from one of the mobile apps."
7269
7463
  ).optional().nullable(),
7270
7464
  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()
7465
+ }).describe("Information about the member's login sessions.").optional(),
7466
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
7273
7467
  }).describe(
7274
7468
  "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
7469
  ).optional(),
@@ -7292,7 +7486,7 @@ var RestoreContactFromTrashBinResponse = z.object({
7292
7486
  var BulkRestoreContactsFromTrashBinRequest = z.object({
7293
7487
  options: z.object({
7294
7488
  contactIds: z.array(z.string()).min(1).max(100).optional(),
7295
- returnEntity: z.boolean().describe("return full entity in response").optional()
7489
+ returnEntity: z.boolean().describe("Whether to include the restored contacts in the response.").optional()
7296
7490
  }).optional()
7297
7491
  });
7298
7492
  var BulkRestoreContactsFromTrashBinResponse = z.object({
@@ -7510,43 +7704,53 @@ var BulkRestoreContactsFromTrashBinResponse = z.object({
7510
7704
  ).optional(),
7511
7705
  segmentIds: z.array(z.string()).max(60).optional(),
7512
7706
  memberInfo: z.object({
7513
- memberId: z.string().describe("Member ID").regex(
7707
+ memberId: z.string().describe("Member ID.").regex(
7514
7708
  /^[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
7709
  "Must be a valid GUID"
7516
7710
  ).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(),
7711
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7712
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7713
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7520
7714
  emailVerificationRequired: z.boolean().describe(
7521
- "Indicates whether the member is required to verify their email"
7715
+ "Whether the member is required to verify their email before they can log in."
7522
7716
  ).optional().nullable(),
7523
7717
  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."
7718
+ "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
7719
  ).optional(),
7526
7720
  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(),
7721
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7722
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7723
+ "Whether the member's profile is visible to other site members and visitors."
7724
+ ).optional(),
7725
+ reported: z.boolean().describe(
7726
+ "Whether the member has been reported by another member."
7727
+ ).optional().nullable(),
7728
+ muted: z.boolean().describe(
7729
+ "Whether the member has been muted and can't post or comment on the site."
7730
+ ).optional().nullable(),
7731
+ photo: z.string().describe("Member's profile photo.").optional()
7732
+ }).describe("Information about the member's public profile.").optional(),
7533
7733
  userInfo: z.object({
7534
- userId: z.string().describe("User ID").regex(
7734
+ userId: z.string().describe("User ID.").regex(
7535
7735
  /^[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
7736
  "Must be a valid GUID"
7537
7737
  ).optional(),
7538
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7539
- }).describe("User info").optional(),
7738
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
7739
+ }).describe("Information about the member's user account.").optional(),
7540
7740
  sessionInfo: z.object({
7541
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
7741
+ lastWebLogin: z.date().describe(
7742
+ "Date and time the member last logged in to the site from a browser."
7743
+ ).optional().nullable(),
7542
7744
  lastMobileLogin: z.date().describe(
7543
- "Last time the member logged in to one of the mobile apps"
7745
+ "Date and time the member last logged in from one of the mobile apps."
7544
7746
  ).optional().nullable(),
7545
7747
  mobileAppNames: z.array(z.string()).max(50).optional()
7546
- }).describe("Session info").optional(),
7748
+ }).describe("Information about the member's login sessions.").optional(),
7547
7749
  groupInfo: z.object({
7548
7750
  groupIds: z.array(z.string()).max(1e3).optional()
7549
- }).describe("Group info").optional()
7751
+ }).describe(
7752
+ "Information about the groups the member belongs to."
7753
+ ).optional()
7550
7754
  }).describe(
7551
7755
  "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
7756
  ).optional(),
@@ -7767,41 +7971,49 @@ var GetDeletedContactResponse = z.object({
7767
7971
  ).optional(),
7768
7972
  segmentIds: z.array(z.string()).max(60).optional(),
7769
7973
  memberInfo: z.object({
7770
- memberId: z.string().describe("Member ID").regex(
7974
+ memberId: z.string().describe("Member ID.").regex(
7771
7975
  /^[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
7976
  "Must be a valid GUID"
7773
7977
  ).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(),
7978
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
7979
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
7980
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
7777
7981
  emailVerificationRequired: z.boolean().describe(
7778
- "Indicates whether the member is required to verify their email"
7982
+ "Whether the member is required to verify their email before they can log in."
7779
7983
  ).optional().nullable(),
7780
7984
  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."
7985
+ "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
7986
  ).optional(),
7783
7987
  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(),
7988
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
7989
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
7990
+ "Whether the member's profile is visible to other site members and visitors."
7991
+ ).optional(),
7992
+ reported: z.boolean().describe(
7993
+ "Whether the member has been reported by another member."
7994
+ ).optional().nullable(),
7995
+ muted: z.boolean().describe(
7996
+ "Whether the member has been muted and can't post or comment on the site."
7997
+ ).optional().nullable(),
7998
+ photo: z.string().describe("Member's profile photo.").optional()
7999
+ }).describe("Information about the member's public profile.").optional(),
7790
8000
  userInfo: z.object({
7791
- userId: z.string().describe("User ID").regex(
8001
+ userId: z.string().describe("User ID.").regex(
7792
8002
  /^[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
8003
  "Must be a valid GUID"
7794
8004
  ).optional(),
7795
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
7796
- }).describe("User info").optional(),
8005
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
8006
+ }).describe("Information about the member's user account.").optional(),
7797
8007
  sessionInfo: z.object({
7798
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
8008
+ lastWebLogin: z.date().describe(
8009
+ "Date and time the member last logged in to the site from a browser."
8010
+ ).optional().nullable(),
7799
8011
  lastMobileLogin: z.date().describe(
7800
- "Last time the member logged in to one of the mobile apps"
8012
+ "Date and time the member last logged in from one of the mobile apps."
7801
8013
  ).optional().nullable(),
7802
8014
  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()
8015
+ }).describe("Information about the member's login sessions.").optional(),
8016
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
7805
8017
  }).describe(
7806
8018
  "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
8019
  ).optional(),
@@ -8028,41 +8240,49 @@ var ListDeletedContactsResponse = z.object({
8028
8240
  ).optional(),
8029
8241
  segmentIds: z.array(z.string()).max(60).optional(),
8030
8242
  memberInfo: z.object({
8031
- memberId: z.string().describe("Member ID").regex(
8243
+ memberId: z.string().describe("Member ID.").regex(
8032
8244
  /^[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
8245
  "Must be a valid GUID"
8034
8246
  ).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(),
8247
+ signupDate: z.date().describe("Date and time the member signed up.").optional().nullable(),
8248
+ email: z.string().describe("Email the member uses to log in.").email().optional().nullable(),
8249
+ emailVerified: z.boolean().describe("Whether the email is verified.").optional().nullable(),
8038
8250
  emailVerificationRequired: z.boolean().describe(
8039
- "Indicates whether the member is required to verify their email"
8251
+ "Whether the member is required to verify their email before they can log in."
8040
8252
  ).optional().nullable(),
8041
8253
  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."
8254
+ "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
8255
  ).optional(),
8044
8256
  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(),
8257
+ nickname: z.string().describe("Member's nickname.").max(255).optional().nullable(),
8258
+ privacyStatus: z.enum(["PRIVATE", "PUBLIC"]).describe(
8259
+ "Whether the member's profile is visible to other site members and visitors."
8260
+ ).optional(),
8261
+ reported: z.boolean().describe(
8262
+ "Whether the member has been reported by another member."
8263
+ ).optional().nullable(),
8264
+ muted: z.boolean().describe(
8265
+ "Whether the member has been muted and can't post or comment on the site."
8266
+ ).optional().nullable(),
8267
+ photo: z.string().describe("Member's profile photo.").optional()
8268
+ }).describe("Information about the member's public profile.").optional(),
8051
8269
  userInfo: z.object({
8052
- userId: z.string().describe("User ID").regex(
8270
+ userId: z.string().describe("User ID.").regex(
8053
8271
  /^[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
8272
  "Must be a valid GUID"
8055
8273
  ).optional(),
8056
- role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("The user's role on the website").optional()
8057
- }).describe("User info").optional(),
8274
+ role: z.enum(["OWNER", "CONTRIBUTOR", "MEMBER"]).describe("Member's role on the site.").optional()
8275
+ }).describe("Information about the member's user account.").optional(),
8058
8276
  sessionInfo: z.object({
8059
- lastWebLogin: z.date().describe("Last time the member logged in to the website").optional().nullable(),
8277
+ lastWebLogin: z.date().describe(
8278
+ "Date and time the member last logged in to the site from a browser."
8279
+ ).optional().nullable(),
8060
8280
  lastMobileLogin: z.date().describe(
8061
- "Last time the member logged in to one of the mobile apps"
8281
+ "Date and time the member last logged in from one of the mobile apps."
8062
8282
  ).optional().nullable(),
8063
8283
  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()
8284
+ }).describe("Information about the member's login sessions.").optional(),
8285
+ groupInfo: z.object({ groupIds: z.array(z.string()).max(1e3).optional() }).describe("Information about the groups the member belongs to.").optional()
8066
8286
  }).describe(
8067
8287
  "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
8288
  ).optional(),