@wix/auto_sdk_members_members 1.0.2 → 1.0.4

package/build/es/src/members-v1-member-members.universal.d.ts

@@ -1,10 +1,14 @@
 export interface Member {
     /**
      * Member ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Email used by the member to log in to the site. */
+    /**
+     * Email used by the member to log in to the site.
+     * @format EMAIL
+     */
     loginEmail?: string | null;
     /**
      * Whether the email used by the member has been verified.
@@ -18,6 +22,7 @@ export interface Member {
     status?: Status;
     /**
      * Contact ID.
+     * @format GUID
      * @readonly
      */
     contactId?: string | null;
@@ -71,7 +76,10 @@ export interface Contact {
     lastName?: string | null;
     /** List of phone numbers. */
     phones?: string[] | null;
-    /** List of email addresses. */
+    /**
+     * List of email addresses.
+     * @format EMAIL
+     */
     emails?: string[] | null;
     /** List of street addresses. */
     addresses?: Address[];
@@ -79,11 +87,18 @@ export interface Contact {
      * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
      *
      * Example: `"2020-03-15"` for March 15, 2020.
+     * @maxLength 100
      */
     birthdate?: string | null;
-    /** Contact's company name. */
+    /**
+     * Contact's company name.
+     * @maxLength 100
+     */
     company?: string | null;
-    /** Contact's job title. */
+    /**
+     * Contact's job title.
+     * @maxLength 100
+     */
     jobTitle?: string | null;
     /**
      * Custom fields are structured as key:value pairs where each key is the field `name`, and each value is the field's `value` for the member.
@@ -98,10 +113,14 @@ export interface Contact {
 export interface Address extends AddressStreetOneOf {
     /** Street address object, with number and name in separate fields. */
     streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
+    /**
+     * Main address line, usually street and number, as free text.
+     * @maxLength 200
+     */
     addressLine?: string | null;
     /**
      * Street address ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
@@ -129,13 +148,22 @@ export interface Address extends AddressStreetOneOf {
 export interface AddressStreetOneOf {
     /** Street address object, with number and name in separate fields. */
     streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
+    /**
+     * Main address line, usually street and number, as free text.
+     * @maxLength 200
+     */
     addressLine?: string | null;
 }
 export interface StreetAddress {
-    /** Street number. */
+    /**
+     * Street number.
+     * @maxLength 100
+     */
     number?: string;
-    /** Street name. */
+    /**
+     * Street name.
+     * @maxLength 200
+     */
     name?: string;
 }
 export interface CustomField {
@@ -227,9 +255,15 @@ export interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 export interface InvalidateCache extends InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -239,7 +273,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
     uri?: URI;
     /** Invalidate by file (for media files such as PDFs) */
     file?: File;
-    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    /**
+     * tell us why you're invalidating the cache. You don't need to add your app name
+     * @maxLength 256
+     */
     reason?: string | null;
     /** Is local DS */
     localDc?: boolean;
@@ -247,9 +284,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
 }
 /** @oneof */
 export interface InvalidateCacheGetByOneOf {
-    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    /**
+     * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
+     * @format GUID
+     */
     siteId?: string;
     /** Invalidate by App */
     app?: App;
@@ -261,31 +304,59 @@ export interface InvalidateCacheGetByOneOf {
     file?: File;
 }
 export interface App {
-    /** The AppDefId */
+    /**
+     * The AppDefId
+     * @minLength 1
+     */
     appDefId?: string;
-    /** The instance Id */
+    /**
+     * The instance Id
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface Page {
-    /** the msid the page is on */
+    /**
+     * the msid the page is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by Page ID */
+    /**
+     * Invalidate by Page ID
+     * @minLength 1
+     */
     pageId?: string;
 }
 export interface URI {
-    /** the msid the URI is on */
+    /**
+     * the msid the URI is on
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    /**
+     * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
+     * @minLength 1
+     */
     uriPath?: string;
 }
 export interface File {
-    /** the msid the file is related to */
+    /**
+     * the msid the file is related to
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** Invalidate by filename (for media files such as PDFs) */
+    /**
+     * Invalidate by filename (for media files such as PDFs)
+     * @minLength 1
+     * @maxLength 256
+     */
     fileName?: string;
 }
 export interface UpdateMySlugRequest {
-    /** New slug. */
+    /**
+     * New slug.
+     * @maxLength 255
+     */
     slug: string;
 }
 export interface UpdateMySlugResponse {
@@ -296,9 +367,15 @@ export interface SlugAlreadyExistsPayload {
     slug?: string;
 }
 export interface UpdateMemberSlugRequest {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     _id: string;
-    /** New slug. */
+    /**
+     * New slug.
+     * @maxLength 255
+     */
     slug: string;
 }
 export interface UpdateMemberSlugResponse {
@@ -315,6 +392,7 @@ export interface JoinCommunityResponse {
 export interface MemberJoinedCommunity {
     /**
      * Member id who joined the community
+     * @format GUID
      * @readonly
      */
     memberId?: string;
@@ -329,6 +407,7 @@ export interface LeaveCommunityResponse {
 export interface MemberLeftCommunity {
     /**
      * Member id who left the community
+     * @format GUID
      * @readonly
      */
     memberId?: string;
@@ -351,6 +430,7 @@ export interface GetMyMemberRequest {
      * Predefined set of fields to return.
      *
      * Default: `PUBLIC`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
 }
@@ -371,7 +451,10 @@ export interface GetMyMemberResponse {
     member?: Member;
 }
 export interface GetMemberRequest {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     _id: string;
     /**
      * Predefined set of fields to return. One of:
@@ -380,6 +463,7 @@ export interface GetMemberRequest {
      * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
      *
      *
+     * @maxSize 3
      */
     fieldsets?: Set[];
 }
@@ -388,7 +472,10 @@ export interface GetMemberResponse {
     member?: Member;
 }
 export interface MemberToMemberBlockedPayload {
-    /** Member ID. */
+    /**
+     * Member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface ListMembersRequest {
@@ -400,6 +487,7 @@ export interface ListMembersRequest {
      * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
      *
      * Default: `"PUBLIC"`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
     sorting?: Sorting[];
@@ -411,7 +499,10 @@ export interface Paging {
     offset?: number | null;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -421,13 +512,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -461,9 +556,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface QueryMembersRequest {
@@ -473,6 +574,7 @@ export interface QueryMembersRequest {
      * Predefined sets of fields to return.
      *
      * Default: `PUBLIC`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
     /** Plain text search. */
@@ -488,7 +590,11 @@ export interface Query {
 }
 /** Free text to match in searchable fields */
 export interface Search {
-    /** Search term or expression. */
+    /**
+     * Search term or expression.
+     * @minLength 1
+     * @maxLength 100
+     */
     expression?: string | null;
     /**
      * Currently supported fields for search:
@@ -501,6 +607,7 @@ export interface Search {
      * - `profile.slug`
      *
      * Default: `profile.nickname`.
+     * @maxSize 4
      */
     fields?: string[];
 }
@@ -511,7 +618,10 @@ export interface QueryMembersResponse {
     metadata?: PagingMetadata;
 }
 export interface MuteMemberRequest {
-    /** ID of the member to mute. */
+    /**
+     * ID of the member to mute.
+     * @format GUID
+     */
     _id: string;
 }
 export interface MuteMemberResponse {
@@ -521,12 +631,16 @@ export interface MuteMemberResponse {
 export interface MemberMuted {
     /**
      * Member id who got muted
+     * @format GUID
      * @readonly
      */
     memberId?: string;
 }
 export interface UnmuteMemberRequest {
-    /** ID of the member to unmute. */
+    /**
+     * ID of the member to unmute.
+     * @format GUID
+     */
     _id: string;
 }
 export interface UnmuteMemberResponse {
@@ -536,12 +650,16 @@ export interface UnmuteMemberResponse {
 export interface MemberUnmuted {
     /**
      * Member id who got unmuted
+     * @format GUID
      * @readonly
      */
     memberId?: string;
 }
 export interface ApproveMemberRequest {
-    /** ID of the member to approve. */
+    /**
+     * ID of the member to approve.
+     * @format GUID
+     */
     _id: string;
 }
 export interface ApproveMemberResponse {
@@ -551,12 +669,16 @@ export interface ApproveMemberResponse {
 export interface MemberApproved {
     /**
      * Member id who got approved
+     * @format GUID
      * @readonly
      */
     memberId?: string;
 }
 export interface BlockMemberRequest {
-    /** ID of a member to block. */
+    /**
+     * ID of a member to block.
+     * @format GUID
+     */
     _id: string;
 }
 export interface BlockMemberResponse {
@@ -566,24 +688,37 @@ export interface BlockMemberResponse {
 export interface MemberBlocked {
     /**
      * Member id who got blocked
+     * @format GUID
      * @readonly
      */
     memberId?: string;
 }
 export interface MemberSelfBlockForbiddenPayload {
-    /** Target's member ID. */
+    /**
+     * Target's member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface OwnerMemberBlockForbiddenPayload {
-    /** Owner's member ID. */
+    /**
+     * Owner's member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface ActiveSubscriptionMemberBlockForbiddenPayload {
-    /** Active subscription member ID. */
+    /**
+     * Active subscription member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface DisconnectMemberRequest {
-    /** ID of a member to disconnect. */
+    /**
+     * ID of a member to disconnect.
+     * @format GUID
+     */
     _id: string;
 }
 export interface DisconnectMemberResponse {
@@ -591,7 +726,10 @@ export interface DisconnectMemberResponse {
     member?: Member;
 }
 export interface DeleteMemberRequest {
-    /** ID of the member to delete. */
+    /**
+     * ID of the member to delete.
+     * @format GUID
+     */
     _id: string;
 }
 export interface DeleteMemberResponse {
@@ -604,21 +742,35 @@ export interface ContentDeletionRequested {
     member?: Member;
 }
 export interface OwnerOrContributorDeleteForbiddenPayload {
-    /** Owner's or contributor's member ID. */
+    /**
+     * Owner's or contributor's member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
-    /** Active subscription member ID. */
+    /**
+     * Active subscription member ID.
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface DeleteMyMemberRequest {
-    /** ID of a member receiving deleted member's content. */
+    /**
+     * ID of a member receiving deleted member's content.
+     * @format GUID
+     */
     contentAssigneeId?: string | null;
 }
 export interface DeleteMyMemberResponse {
 }
 export interface BulkDeleteMembersRequest {
-    /** IDs of members to be deleted. */
+    /**
+     * IDs of members to be deleted.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
     memberIds: string[];
 }
 export interface BulkDeleteMembersResponse {
@@ -628,7 +780,10 @@ export interface BulkDeleteMembersResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @maxLength 255
+     */
     _id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -659,7 +814,10 @@ export interface BulkActionMetadata {
 export interface BulkDeleteMembersByFilterRequest {
     /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
     filter: any;
-    /** ID of a member receiving the deleted member's content. */
+    /**
+     * ID of a member receiving the deleted member's content.
+     * @format GUID
+     */
     contentAssigneeId?: string | null;
     /** Plain text search. */
     search?: Search;
@@ -714,7 +872,10 @@ export interface InvalidCustomFieldUrlPayload {
     fields?: Record<string, string>;
 }
 export interface DeleteMemberPhonesRequest {
-    /** ID of the member whose phone numbers will be deleted. */
+    /**
+     * ID of the member whose phone numbers will be deleted.
+     * @format GUID
+     */
     _id: string;
 }
 export interface DeleteMemberPhonesResponse {
@@ -722,7 +883,10 @@ export interface DeleteMemberPhonesResponse {
     member?: Member;
 }
 export interface DeleteMemberEmailsRequest {
-    /** ID of the member whose email addresses will be deleted. */
+    /**
+     * ID of the member whose email addresses will be deleted.
+     * @format GUID
+     */
     _id: string;
 }
 export interface DeleteMemberEmailsResponse {
@@ -730,7 +894,10 @@ export interface DeleteMemberEmailsResponse {
     member?: Member;
 }
 export interface DeleteMemberAddressesRequest {
-    /** ID of the member whose street addresses will be deleted. */
+    /**
+     * ID of the member whose street addresses will be deleted.
+     * @format GUID
+     */
     _id: string;
 }
 export interface DeleteMemberAddressesResponse {
@@ -840,7 +1007,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     studioAssigned?: StudioAssigned;
     /** Emitted when Studio is detached. */
     studioUnassigned?: StudioUnassigned;
-    /** A meta site id. */
+    /**
+     * A meta site id.
+     * @format GUID
+     */
     metaSiteId?: string;
     /** A meta site version. Monotonically increasing. */
     version?: string;
@@ -849,6 +1019,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
     /**
      * TODO(meta-site): Change validation once validations are disabled for consumers
      * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
      */
     assets?: Asset[];
 }
@@ -886,9 +1057,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
     studioUnassigned?: StudioUnassigned;
 }
 export interface Asset {
-    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    /**
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** An instance id. For legacy reasons may be UUID or a string. */
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
     instanceId?: string;
     /** An application state. */
     state?: State;
@@ -901,9 +1078,15 @@ export declare enum State {
     DEMO = "DEMO"
 }
 export interface SiteCreated {
-    /** A template identifier (empty if not created from a template). */
+    /**
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
+     */
     originTemplateId?: string;
-    /** An account id of the owner. */
+    /**
+     * An account id of the owner.
+     * @format GUID
+     */
     ownerId?: string;
     /** A context in which meta site was created. */
     context?: SiteCreatedContext;
@@ -912,9 +1095,13 @@ export interface SiteCreated {
      *
      * In case of a creation from a template it's a template id.
      * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * @format GUID
      */
     originMetaSiteId?: string | null;
-    /** A meta site name (URL slug). */
+    /**
+     * A meta site name (URL slug).
+     * @maxLength 20
+     */
     siteName?: string;
     /** A namespace. */
     namespace?: Namespace;
@@ -1011,9 +1198,15 @@ export declare enum Namespace {
 }
 /** Site transferred to another user. */
 export interface SiteTransferred {
-    /** A previous owner id (user that transfers meta site). */
+    /**
+     * A previous owner id (user that transfers meta site).
+     * @format GUID
+     */
     oldOwnerId?: string;
-    /** A new owner id (user that accepts meta site). */
+    /**
+     * A new owner id (user that accepts meta site).
+     * @format GUID
+     */
     newOwnerId?: string;
 }
 /** Soft deletion of the meta site. Could be restored. */
@@ -1026,16 +1219,23 @@ export interface DeleteContext {
     dateDeleted?: Date | null;
     /** A status. */
     deleteStatus?: DeleteStatus;
-    /** A reason (flow). */
+    /**
+     * A reason (flow).
+     * @maxLength 255
+     */
     deleteOrigin?: string;
-    /** A service that deleted it. */
+    /**
+     * A service that deleted it.
+     * @maxLength 255
+     */
     initiatorId?: string | null;
 }
 export declare enum DeleteStatus {
     UNKNOWN = "UNKNOWN",
     TRASH = "TRASH",
     DELETED = "DELETED",
-    PENDING_PURGE = "PENDING_PURGE"
+    PENDING_PURGE = "PENDING_PURGE",
+    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
 }
 /** Restoration of the meta site. */
 export interface SiteUndeleted {
@@ -1044,7 +1244,11 @@ export interface SiteUndeleted {
 export interface SitePublished {
 }
 export interface SiteUnpublished {
-    /** A list of URLs previously associated with the meta site. */
+    /**
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
+     */
     urls?: string[];
 }
 export interface SiteMarkedAsTemplate {
@@ -1067,30 +1271,60 @@ export interface SiteMarkedAsWixSite {
  * To ensure this, the TPA on the template gets a new instance_id.
  */
 export interface ServiceProvisioned {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** An instance id from which this instance is originated. */
+    /**
+     * An instance id from which this instance is originated.
+     * @maxLength 36
+     */
     originInstanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
-    /** The origin meta site id */
+    /**
+     * The origin meta site id
+     * @format GUID
+     */
     originMetaSiteId?: string | null;
 }
 export interface ServiceRemoved {
-    /** Either UUID or EmbeddedServiceType. */
+    /**
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
+     */
     appDefId?: string;
-    /** Not only UUID. Something here could be something weird. */
+    /**
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
+     */
     instanceId?: string;
-    /** A version. */
+    /**
+     * A version.
+     * @maxLength 500
+     */
     version?: string | null;
 }
 /** Rename of the site. Meaning, free public url has been changed as well. */
 export interface SiteRenamed {
-    /** A new meta site name (URL slug). */
+    /**
+     * A new meta site name (URL slug).
+     * @maxLength 20
+     */
     newSiteName?: string;
-    /** A previous meta site name (URL slug). */
+    /**
+     * A previous meta site name (URL slug).
+     * @maxLength 255
+     */
     oldSiteName?: string;
 }
 /**
@@ -1119,13 +1353,21 @@ export interface MemberOwnershipTransferred {
     toMember?: Member;
 }
 export interface MemberIdChanged {
+    /** @format GUID */
     fromId?: string;
+    /** @format GUID */
     toId?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1133,26 +1375,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -1274,9 +1540,15 @@ export interface DeleteMemberAddressesResponseNonNullableFields {
     member?: MemberNonNullableFields;
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -1345,6 +1617,8 @@ export interface MemberCreatedEnvelope {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @permissionId MEMBERS.MEMBER_READ
@@ -1375,6 +1649,8 @@ export interface MemberDeletedEnvelope {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @permissionId MEMBERS.MEMBER_READ
@@ -1404,6 +1680,8 @@ export interface MemberUpdatedEnvelope {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @permissionId MEMBERS.MEMBER_READ
@@ -1437,6 +1715,8 @@ export declare function onMemberUpdated(handler: (event: MemberUpdatedEnvelope)
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.api.Members.UpdateMySlug
@@ -1462,6 +1742,8 @@ export declare function updateCurrentMemberSlug(slug: string): Promise<UpdateMyS
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.api.Members.UpdateMemberSlug
@@ -1532,6 +1814,8 @@ export declare function leaveCommunity(): Promise<LeaveCommunityResponse & Leave
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
@@ -1558,6 +1842,7 @@ export interface GetCurrentMemberOptions {
      * Predefined set of fields to return.
      *
      * Default: `PUBLIC`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
 }
@@ -1587,6 +1872,8 @@ export interface GetCurrentMemberOptions {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
@@ -1603,6 +1890,7 @@ export interface GetMemberOptions {
      * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
      *
      * Default: `"PUBLIC"`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
 }
@@ -1630,6 +1918,8 @@ export interface GetMemberOptions {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @applicableIdentity APP
@@ -1647,6 +1937,7 @@ export interface ListMembersOptions {
      * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
      *
      * Default: `"PUBLIC"`.
+     * @maxSize 3
      */
     fieldsets?: Set[];
     /** Sorting options. */
@@ -1689,6 +1980,8 @@ export interface ListMembersOptions {
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionScope Read Members
  * @permissionScopeId SCOPE.DC-MEMBERS.READ-MEMBERS
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @permissionScope Manage Members and Contacts - all permissions
  * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
  * @permissionId MEMBERS.MEMBER_READ
@@ -1705,6 +1998,7 @@ export interface QueryMembersOptions {
      * - `"EXTENDED"`: Returns `id`, `loginEmail`, `status`, `contactId`, `privacyStatus`, `activityStatus`, and the `profile` object.
      *
      * Default: `"PUBLIC"`.
+     * @maxSize 3
      */
     fieldsets?: Set[] | undefined;
     /** Plain text search. */
@@ -1864,7 +2158,10 @@ export declare function deleteMember(_id: string): Promise<void>;
  */
 export declare function deleteMyMember(options?: DeleteMyMemberOptions): Promise<void>;
 export interface DeleteMyMemberOptions {
-    /** ID of a member receiving deleted member's content. */
+    /**
+     * ID of a member receiving deleted member's content.
+     * @format GUID
+     */
     contentAssigneeId?: string | null;
 }
 /**
@@ -1896,7 +2193,10 @@ export declare function bulkDeleteMembers(memberIds: string[]): Promise<BulkDele
  */
 export declare function bulkDeleteMembersByFilter(filter: any, options?: BulkDeleteMembersByFilterOptions): Promise<BulkDeleteMembersByFilterResponse & BulkDeleteMembersByFilterResponseNonNullableFields>;
 export interface BulkDeleteMembersByFilterOptions {
-    /** ID of a member receiving the deleted member's content. */
+    /**
+     * ID of a member receiving the deleted member's content.
+     * @format GUID
+     */
     contentAssigneeId?: string | null;
     /** Plain text search. */
     search?: Search;
@@ -1988,6 +2288,8 @@ export interface CreateMemberOptions {
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @returns Updated member.
@@ -1997,10 +2299,14 @@ export declare function updateMember(_id: string | null, member: UpdateMember):
 export interface UpdateMember {
     /**
      * Member ID.
+     * @format GUID
      * @readonly
      */
     _id?: string | null;
-    /** Email used by the member to log in to the site. */
+    /**
+     * Email used by the member to log in to the site.
+     * @format EMAIL
+     */
     loginEmail?: string | null;
     /**
      * Whether the email used by the member has been verified.
@@ -2014,6 +2320,7 @@ export interface UpdateMember {
     status?: Status;
     /**
      * Contact ID.
+     * @format GUID
      * @readonly
      */
     contactId?: string | null;
@@ -2071,6 +2378,8 @@ export interface UpdateMember {
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.api.Members.DeleteMemberPhones
@@ -2103,6 +2412,8 @@ export declare function deleteMemberPhones(_id: string): Promise<DeleteMemberPho
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.api.Members.DeleteMemberEmails
@@ -2132,6 +2443,8 @@ export declare function deleteMemberEmails(_id: string): Promise<DeleteMemberEma
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Manage Restaurants - all permissions
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Set Up Automations
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
  * @applicableIdentity APP
  * @applicableIdentity MEMBER
  * @fqn com.wixpress.members.api.Members.DeleteMemberAddresses