import { UpdateMySlugRequest as UpdateMySlugRequest$1, UpdateMySlugResponse as UpdateMySlugResponse$1, UpdateMemberSlugRequest as UpdateMemberSlugRequest$1, UpdateMemberSlugResponse as UpdateMemberSlugResponse$1, JoinCommunityRequest as JoinCommunityRequest$1, JoinCommunityResponse as JoinCommunityResponse$1, LeaveCommunityRequest as LeaveCommunityRequest$1, LeaveCommunityResponse as LeaveCommunityResponse$1, GetMyMemberRequest as GetMyMemberRequest$1, GetMyMemberResponse as GetMyMemberResponse$1, GetMemberRequest as GetMemberRequest$1, GetMemberResponse as GetMemberResponse$1, ListMembersRequest as ListMembersRequest$1, ListMembersResponse as ListMembersResponse$1, QueryMembersRequest as QueryMembersRequest$1, QueryMembersResponse as QueryMembersResponse$1, MuteMemberRequest as MuteMemberRequest$1, MuteMemberResponse as MuteMemberResponse$1, UnmuteMemberRequest as UnmuteMemberRequest$1, UnmuteMemberResponse as UnmuteMemberResponse$1, ApproveMemberRequest as ApproveMemberRequest$1, ApproveMemberResponse as ApproveMemberResponse$1, BlockMemberRequest as BlockMemberRequest$1, BlockMemberResponse as BlockMemberResponse$1, DisconnectMemberRequest as DisconnectMemberRequest$1, DisconnectMemberResponse as DisconnectMemberResponse$1, DeleteMemberRequest as DeleteMemberRequest$1, DeleteMemberResponse as DeleteMemberResponse$1, DeleteMyMemberRequest as DeleteMyMemberRequest$1, DeleteMyMemberResponse as DeleteMyMemberResponse$1, BulkDeleteMembersRequest as BulkDeleteMembersRequest$1, BulkDeleteMembersResponse as BulkDeleteMembersResponse$1, BulkDeleteMembersByFilterRequest as BulkDeleteMembersByFilterRequest$1, BulkDeleteMembersByFilterResponse as BulkDeleteMembersByFilterResponse$1, BulkApproveMembersRequest as BulkApproveMembersRequest$1, BulkApproveMembersResponse as BulkApproveMembersResponse$1, BulkBlockMembersRequest as BulkBlockMembersRequest$1, BulkBlockMembersResponse as BulkBlockMembersResponse$1, CreateMemberRequest as CreateMemberRequest$1, CreateMemberResponse as CreateMemberResponse$1, UpdateMemberRequest as UpdateMemberRequest$1, UpdateMemberResponse as UpdateMemberResponse$1, DeleteMemberPhonesRequest as DeleteMemberPhonesRequest$1, DeleteMemberPhonesResponse as DeleteMemberPhonesResponse$1, DeleteMemberEmailsRequest as DeleteMemberEmailsRequest$1, DeleteMemberEmailsResponse as DeleteMemberEmailsResponse$1, DeleteMemberAddressesRequest as DeleteMemberAddressesRequest$1, DeleteMemberAddressesResponse as DeleteMemberAddressesResponse$1 } from './index.typings.mjs'; import '@wix/sdk-types'; /** * A registered user of a Wix site who can log in, access member-only content, and participate in site activities. * Members have profiles, contact information, and can interact with site features such as forums, blogs, and community features. */ interface Member { /** * Member ID. * @format GUID * @readonly */ id?: string | null; /** * Email used by a member to log in to the site. * @format EMAIL * @immutable */ loginEmail?: string | null; /** * Whether the email used by a member has been verified. * @readonly */ loginEmailVerified?: boolean | null; /** * Member site access status. * @readonly */ status?: StatusWithLiterals; /** * Contact ID. * @format GUID * @readonly */ contactId?: string | null; /** * Member's contact information. Contact information is stored in the * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts). * * The full set of contact data can be accessed and managed with the * [Contacts API](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/introduction). */ contact?: Contact; /** Profile display details. */ profile?: Profile; /** Member privacy status. */ privacyStatus?: PrivacyStatusStatusWithLiterals; /** * Member activity status. * @readonly */ activityStatus?: ActivityStatusStatusWithLiterals; /** * Date and time when the member was created. * @readonly */ createdDate?: Date | null; /** * Date and time when the member was updated. * @readonly */ updatedDate?: Date | null; /** * Date and time when the member last logged in to the site. * @readonly */ lastLoginDate?: Date | null; } declare enum Status { /** Insufficient permissions to get the status. */ UNKNOWN = "UNKNOWN", /** Member is created and is waiting for approval by a Wix user. */ PENDING = "PENDING", /** Member can log in to the site. */ APPROVED = "APPROVED", /** Member is blocked and can't log in to the site. */ BLOCKED = "BLOCKED", /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and can't log in to the site. */ OFFLINE = "OFFLINE" } /** @enumType */ type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'APPROVED' | 'BLOCKED' | 'OFFLINE'; /** Contact info associated with the member. */ interface Contact { /** Contact's first name. */ firstName?: string | null; /** Contact's last name. */ lastName?: string | null; /** List of phone numbers. */ phones?: string[] | null; /** * List of email addresses. * @format EMAIL * @immutable */ emails?: string[] | null; /** List of street addresses. */ addresses?: Address[]; /** * 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. * @maxLength 100 */ company?: string | null; /** * Contact's job title. * @maxLength 100 */ jobTitle?: string | null; /** * Custom fields, * where each key is the field key, * and each value is the field's value for the member. */ customFields?: Record; } /** Street address. */ 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. * @maxLength 200 */ addressLine?: string | null; /** * Street address ID. * @format GUID * @readonly */ id?: string | null; /** * Free text providing more detailed address information, * such as apartment, suite, or floor. */ addressLine2?: string | null; /** City name. */ city?: string | null; /** * Code for a subdivision (such as state, prefecture, or province) in an * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */ subdivision?: string | null; /** * 2-letter country code in an * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */ country?: string | null; /** Postal code. */ postalCode?: string | null; } /** @oneof */ interface AddressStreetOneOf { /** Street address object, with number and name in separate fields. */ streetAddress?: StreetAddress; /** * Main address line, usually street and number, as free text. * @maxLength 200 */ addressLine?: string | null; } interface StreetAddress { /** * Street number. * @maxLength 100 */ number?: string; /** * Street name. * @maxLength 200 */ name?: string; } interface CustomField { /** Custom field name. */ name?: string | null; /** Custom field value. */ value?: any; } /** Member Profile */ interface Profile { /** * Name that identifies the member to other members. * Displayed on the member's profile page * and interactions in the forum or blog. */ nickname?: string | null; /** * Slug that determines the member's profile page URL. * @readonly */ slug?: string | null; /** Member's profile photo. */ photo?: Image; /** * Member's cover photo, * used as a background picture in a member's profile page. * * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`. * When left empty, the values default to `0`. */ cover?: Image; /** Member title. */ title?: string | null; } interface Image { /** * Wix Media image ID, * set when the member selects an image from Wix Media. */ id?: string; /** Image URL. */ url?: string; /** Original image width. */ height?: number; /** Original image height. */ width?: number; /** * X-axis offset. * * Default: `0`. */ offsetX?: number | null; /** * Y-axis offset. * * Default: `0`. */ offsetY?: number | null; } declare enum PrivacyStatusStatus { /** Insufficient permissions to get the status. */ UNKNOWN = "UNKNOWN", /** Member is hidden from site visitors and other site members. Member is returned only to Wix users. */ PRIVATE = "PRIVATE", /** Member is visible to everyone. */ PUBLIC = "PUBLIC" } /** @enumType */ type PrivacyStatusStatusWithLiterals = PrivacyStatusStatus | 'UNKNOWN' | 'PRIVATE' | 'PUBLIC'; declare enum ActivityStatusStatus { /** Insufficient permissions to get the status. */ UNKNOWN = "UNKNOWN", /** Member can write forum posts and blog comments. */ ACTIVE = "ACTIVE", /** Member can't write forum posts or blog comments. */ MUTED = "MUTED" } /** @enumType */ type ActivityStatusStatusWithLiterals = ActivityStatusStatus | 'UNKNOWN' | 'ACTIVE' | 'MUTED'; interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } interface InvalidateCache extends InvalidateCacheGetByOneOf { /** * 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! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; /** * 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; hardPurge?: boolean; /** * Optional caller-provided ID for tracking this invalidation through the system. * When set, the corresponding CDN purge completion event will include this ID, * allowing you to confirm when the invalidation has fully propagated. * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event. * @maxLength 256 */ correlationId?: string | null; } /** @oneof */ interface InvalidateCacheGetByOneOf { /** * 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! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; } interface App { /** * The AppDefId * @minLength 1 */ appDefId?: string; /** * The instance Id * @format GUID */ instanceId?: string; } interface Page { /** * the msid the page is on * @format GUID */ metaSiteId?: string; /** * Invalidate by Page ID * @minLength 1 */ pageId?: string; } interface URI { /** * the msid the URI is on * @format GUID */ metaSiteId?: string; /** * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes * @minLength 1 */ uriPath?: string; } interface File { /** * the msid the file is related to * @format GUID */ metaSiteId?: string; /** * Invalidate by filename (for media files such as PDFs) * @minLength 1 * @maxLength 256 */ fileName?: string; } interface CustomTag { /** * the msid the tag is related to * @format GUID */ metaSiteId?: string; /** * Tag to invalidate by * @minLength 1 * @maxLength 256 */ tag?: string; } interface Pages { /** * the msid the pages are on * @format GUID */ metaSiteId?: string; /** * Invalidate by multiple Page IDs in a single message * @maxSize 100 * @minLength 1 */ pageIds?: string[]; } interface URIs { /** * the msid the URIs are on * @format GUID */ metaSiteId?: string; /** * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes * @maxSize 100 * @minLength 1 */ uriPaths?: string[]; } interface UpdateMySlugRequest { /** * New slug. * @maxLength 255 */ slug: string; } interface UpdateMySlugResponse { /** Updated member. */ member?: Member; } interface SlugAlreadyExistsPayload { slug?: string; } interface UpdateMemberSlugRequest { /** * Member ID. * @format GUID */ id: string; /** * New slug. * @maxLength 255 */ slug: string; } interface UpdateMemberSlugResponse { /** Updated member. */ member?: Member; } interface JoinCommunityRequest { } /** Member profile. */ interface JoinCommunityResponse { /** The updated member. */ member?: Member; } interface MemberJoinedCommunity { /** * ID of the member who joined the community. * @format GUID * @readonly */ memberId?: string; } interface LeaveCommunityRequest { } /** Member profile. */ interface LeaveCommunityResponse { /** The updated member. */ member?: Member; } interface MemberLeftCommunity { /** * ID of the site member who left the community. * @format GUID * @readonly */ memberId?: string; } interface GetMyMemberRequest { /** * Predefined set of fields to return. * * Default: `"PUBLIC"`. * @maxSize 3 */ fieldsets?: SetWithLiterals[]; } declare enum Set { /** * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object. * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`. */ PUBLIC = "PUBLIC", /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */ EXTENDED = "EXTENDED", /** Includes all fields. */ FULL = "FULL" } /** @enumType */ type SetWithLiterals = Set | 'PUBLIC' | 'EXTENDED' | 'FULL'; /** Member profile. */ interface GetMyMemberResponse { /** The retrieved member. */ member?: Member; } interface GetMemberRequest { /** * Member ID. * @format GUID */ id: string; /** * Predefined set of fields to return. * * Defaults to `"PUBLIC"`. * @maxSize 3 */ fieldsets?: SetWithLiterals[]; } interface GetMemberResponse { /** The requested member. */ member?: Member; } interface MemberToMemberBlockedPayload { /** * Member ID. * @format GUID */ memberId?: string; } interface ListMembersRequest { paging?: Paging; /** * Predefined sets of fields to return. * * Default: `"PUBLIC"`. * @maxSize 3 */ fieldsets?: SetWithLiterals[]; sorting?: Sorting[]; } interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface CursorPaging { /** * 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; } interface ListMembersResponse { /** List of members. */ members?: Member[]; /** Metadata for the paginated results. */ metadata?: PagingMetadata; } interface PagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; } interface CursorPagingMetadata { /** Number of items returned in the response. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; } interface Cursors { /** * 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. * @maxLength 16000 */ prev?: string | null; } interface QueryMembersRequest { /** Query options. */ query?: Query; /** * Predefined sets of fields to return. * * Default: `"PUBLIC"`. * @maxSize 3 */ fieldsets?: SetWithLiterals[]; /** Plain text search. */ search?: Search; } interface Query { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ filter?: any; /** Limit number of results */ paging?: Paging; /** Sort the results */ sorting?: Sorting[]; } /** Free text to match in searchable fields */ interface Search { /** * Search term or expression. * @minLength 1 * @maxLength 100 */ expression?: string | null; /** * Currently supported fields for search: * * - `loginEmail` * - `contact.firstName` * - `contact.lastName` * - `profile.title` * - `profile.nickname` * - `profile.slug` * * Default: `profile.nickname`. * @maxSize 4 */ fields?: string[]; } interface QueryMembersResponse { /** List of members that met the query filter criteria. */ members?: Member[]; /** Metadata for the paginated results. */ metadata?: PagingMetadata; } interface MuteMemberRequest { /** * ID of the member to mute. * @format GUID */ id: string; } interface MuteMemberResponse { /** Muted member. */ member?: Member; } interface MemberMuted { /** * ID of the member who got muted. * @format GUID * @readonly */ memberId?: string; } interface UnmuteMemberRequest { /** * ID of the member to unmute. * @format GUID */ id: string; } interface UnmuteMemberResponse { /** Unmuted member. */ member?: Member; } interface MemberUnmuted { /** * ID of the member who got unmuted. * @format GUID * @readonly */ memberId?: string; } interface ApproveMemberRequest { /** * ID of the member to approve. * @format GUID */ id: string; } interface ApproveMemberResponse { /** Approved member. */ member?: Member; } interface MemberApproved { /** * ID of the member who got approved. * @format GUID * @readonly */ memberId?: string; } interface BlockMemberRequest { /** * ID of a member to block. * @format GUID */ id: string; } interface BlockMemberResponse { /** Blocked member. */ member?: Member; } interface MemberBlocked { /** * ID of the member who got blocked. * @format GUID * @readonly */ memberId?: string; } interface MemberSelfBlockForbiddenPayload { /** * Target's member ID. * @format GUID */ memberId?: string; } interface OwnerMemberBlockForbiddenPayload { /** * Owner's member ID. * @format GUID */ memberId?: string; } interface ActiveSubscriptionMemberBlockForbiddenPayload { /** * Active subscription member ID. * @format GUID */ memberId?: string; } interface DisconnectMemberRequest { /** * ID of a member to disconnect. * @format GUID */ id: string; } interface DisconnectMemberResponse { /** Disconnected member. */ member?: Member; } interface DeleteMemberRequest { /** * ID of a member to delete. * @format GUID */ id: string; } interface DeleteMemberResponse { } interface ContentReassignmentRequested { fromMember?: Member; toMember?: Member; } interface ContentDeletionRequested { member?: Member; } interface OwnerOrContributorDeleteForbiddenPayload { /** * Owner's or contributor's member ID. * @format GUID */ memberId?: string; } interface ActiveSubscriptionMemberDeleteForbiddenPayload { /** * Active subscription member ID. * @format GUID */ memberId?: string; } interface DeleteMyMemberRequest { /** * ID of a member receiving the deleted member's content. * @format GUID */ contentAssigneeId?: string | null; } interface DeleteMyMemberResponse { } interface BulkDeleteMembersRequest { /** * IDs of members to be deleted. * @minSize 1 * @maxSize 100 * @format GUID */ memberIds: string[]; } interface BulkDeleteMembersResponse { /** Result. */ results?: BulkMemberResult[]; /** Bulk action result metadata. */ bulkActionMetadata?: BulkActionMetadata; } interface ItemMetadata { /** * 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; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkMemberResult { itemMetadata?: ItemMetadata; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } 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. * @format GUID */ contentAssigneeId?: string | null; /** Plain text search. */ search?: Search; } interface BulkDeleteMembersByFilterResponse { /** * Job ID. * Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */ jobId?: string; } interface BulkApproveMembersRequest { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ filter: any; } interface BulkApproveMembersResponse { /** * Job ID. * Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */ jobId?: string; } interface BulkBlockMembersRequest { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ filter: any; } interface BulkBlockMembersResponse { /** * Job ID. * Specify this ID when calling [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata. */ jobId?: string; } interface CreateMemberRequest { /** Member to create. */ member?: Member; } interface CreateMemberResponse { /** New member. */ member?: Member; } interface UpdateMemberRequest { /** Member info to update. */ member?: Member; } interface UpdateMemberResponse { /** Updated member. */ member?: Member; } interface InvalidCustomFieldUrlPayload { /** Custom field key and invalid URL. */ fields?: Record; } interface DeleteMemberPhonesRequest { /** * ID of the member whose phone numbers will be deleted. * @format GUID */ id: string; } interface DeleteMemberPhonesResponse { /** Updated member. */ member?: Member; } interface DeleteMemberEmailsRequest { /** * ID of the member whose email addresses will be deleted. * @format GUID */ id: string; } interface DeleteMemberEmailsResponse { /** Updated member. */ member?: Member; } interface DeleteMemberAddressesRequest { /** * ID of the member whose street addresses will be deleted. * @format GUID */ id: string; } interface DeleteMemberAddressesResponse { /** Updated member. */ member?: Member; } interface Empty { } interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * A meta site id. * @format GUID */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * 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[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } interface Asset { /** * 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. * @maxLength 200 */ instanceId?: string; /** An application state. */ state?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; interface SiteCreated { /** * A template identifier (empty if not created from a template). * @maxLength 36 */ originTemplateId?: string; /** * An account id of the owner. * @format GUID */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContextWithLiterals; /** * A meta site id from which this site was created. * * 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). * @maxLength 20 */ siteName?: string; /** A namespace. */ namespace?: NamespaceWithLiterals; } declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */ SHOUT_OUT = "SHOUT_OUT", /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ALBUMS = "ALBUMS", /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_SITE = "DEV_SITE", /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ LOGOS = "LOGOS", /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE", /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_FORMS = "STANDALONE_FORMS", /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_EVENTS = "STANDALONE_EVENTS", /** MIMIR - Siteless account for MIMIR Ai Job runner. */ MIMIR = "MIMIR", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS", /** Nautilus platform. */ NAUTILUS = "NAUTILUS", /** * Symphony — a siteless site representing a project within Symphony (the evolution of Orion). * Holds project data, conversations, assets, and manages collaborators / shared team members for the project. */ SYMPHONY = "SYMPHONY" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY'; /** Site transferred to another user. */ interface SiteTransferred { /** * A previous owner id (user that transfers meta site). * @format GUID */ oldOwnerId?: string; /** * A new owner id (user that accepts meta site). * @format GUID */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ interface ServiceProvisioned { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * An instance id from which this instance is originated. * @maxLength 36 */ originInstanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; /** * The origin meta site id * @format GUID */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed { /** * A new meta site name (URL slug). * @maxLength 20 */ newSiteName?: string; /** * A previous meta site name (URL slug). * @maxLength 255 */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } /** * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc. * * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up * with sites and its urls, you need to listen to another topic/event. Read about it: * * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service */ interface SiteUrlChanged { } /** * Used at the end of the deletion flow for both draft sites and when a user deletes a site. * Consumed by other teams to remove relevant data. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface MemberOwnershipTransferred { fromMember?: Member; toMember?: Member; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface MemberIdChanged { /** @format GUID */ fromId?: string; /** @format GUID */ toId?: string; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * 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. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * 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. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } /** @docsIgnore */ type UpdateMySlugApplicationErrors = { code?: 'SLUG_ALREADY_EXISTS'; description?: string; data?: SlugAlreadyExistsPayload; }; /** @docsIgnore */ type UpdateMemberSlugApplicationErrors = { code?: 'SLUG_ALREADY_EXISTS'; description?: string; data?: SlugAlreadyExistsPayload; }; /** @docsIgnore */ type JoinCommunityApplicationErrors = { code?: 'COMMUNITY_JOIN_IMPOSSIBLE'; description?: string; data?: Record; }; /** @docsIgnore */ type GetMyMemberApplicationErrors = { code?: 'NOT_FOUND'; description?: string; data?: Record; }; /** @docsIgnore */ type GetMemberApplicationErrors = { code?: 'MEMBER_TO_MEMBER_BLOCKED'; description?: string; data?: MemberToMemberBlockedPayload; }; /** @docsIgnore */ type BlockMemberApplicationErrors = { code?: 'MEMBER_SELF_BLOCK_FORBIDDEN'; description?: string; data?: MemberSelfBlockForbiddenPayload; } | { code?: 'OWNER_MEMBER_BLOCK_FORBIDDEN'; description?: string; data?: OwnerMemberBlockForbiddenPayload; } | { code?: 'ACTIVE_SUBSCRIPTION_MEMBER_BLOCK_FORBIDDEN'; description?: string; data?: ActiveSubscriptionMemberBlockForbiddenPayload; }; /** @docsIgnore */ type DeleteMemberValidationErrors = { ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN'; } | { ruleName?: 'ACTIVE_SUBSCRIPTION_MEMBER_DELETE_FORBIDDEN'; }; /** @docsIgnore */ type DeleteMyMemberValidationErrors = { ruleName?: 'OWNER_OR_CONTRIBUTOR_MEMBER_DELETE_FORBIDDEN'; }; /** @docsIgnore */ type UpdateMemberValidationErrors = { ruleName?: 'INVALID_CUSTOM_FIELD_URL'; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function updateCurrentMemberSlug(): __PublicMethodMetaInfo<'POST', {}, UpdateMySlugRequest$1, UpdateMySlugRequest, UpdateMySlugResponse$1, UpdateMySlugResponse>; declare function updateMemberSlug(): __PublicMethodMetaInfo<'POST', { id: string; }, UpdateMemberSlugRequest$1, UpdateMemberSlugRequest, UpdateMemberSlugResponse$1, UpdateMemberSlugResponse>; declare function joinCommunity(): __PublicMethodMetaInfo<'POST', {}, JoinCommunityRequest$1, JoinCommunityRequest, JoinCommunityResponse$1, JoinCommunityResponse>; declare function leaveCommunity(): __PublicMethodMetaInfo<'POST', {}, LeaveCommunityRequest$1, LeaveCommunityRequest, LeaveCommunityResponse$1, LeaveCommunityResponse>; declare function getCurrentMember(): __PublicMethodMetaInfo<'GET', {}, GetMyMemberRequest$1, GetMyMemberRequest, GetMyMemberResponse$1, GetMyMemberResponse>; declare function getMember(): __PublicMethodMetaInfo<'GET', { id: string; }, GetMemberRequest$1, GetMemberRequest, GetMemberResponse$1, GetMemberResponse>; declare function listMembers(): __PublicMethodMetaInfo<'GET', {}, ListMembersRequest$1, ListMembersRequest, ListMembersResponse$1, ListMembersResponse>; declare function queryMembers(): __PublicMethodMetaInfo<'POST', {}, QueryMembersRequest$1, QueryMembersRequest, QueryMembersResponse$1, QueryMembersResponse>; declare function muteMember(): __PublicMethodMetaInfo<'POST', { id: string; }, MuteMemberRequest$1, MuteMemberRequest, MuteMemberResponse$1, MuteMemberResponse>; declare function unmuteMember(): __PublicMethodMetaInfo<'POST', { id: string; }, UnmuteMemberRequest$1, UnmuteMemberRequest, UnmuteMemberResponse$1, UnmuteMemberResponse>; declare function approveMember(): __PublicMethodMetaInfo<'POST', { id: string; }, ApproveMemberRequest$1, ApproveMemberRequest, ApproveMemberResponse$1, ApproveMemberResponse>; declare function blockMember(): __PublicMethodMetaInfo<'POST', { id: string; }, BlockMemberRequest$1, BlockMemberRequest, BlockMemberResponse$1, BlockMemberResponse>; declare function disconnectMember(): __PublicMethodMetaInfo<'POST', { id: string; }, DisconnectMemberRequest$1, DisconnectMemberRequest, DisconnectMemberResponse$1, DisconnectMemberResponse>; declare function deleteMember(): __PublicMethodMetaInfo<'DELETE', { id: string; }, DeleteMemberRequest$1, DeleteMemberRequest, DeleteMemberResponse$1, DeleteMemberResponse>; declare function deleteMyMember(): __PublicMethodMetaInfo<'DELETE', {}, DeleteMyMemberRequest$1, DeleteMyMemberRequest, DeleteMyMemberResponse$1, DeleteMyMemberResponse>; declare function bulkDeleteMembers(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteMembersRequest$1, BulkDeleteMembersRequest, BulkDeleteMembersResponse$1, BulkDeleteMembersResponse>; declare function bulkDeleteMembersByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteMembersByFilterRequest$1, BulkDeleteMembersByFilterRequest, BulkDeleteMembersByFilterResponse$1, BulkDeleteMembersByFilterResponse>; declare function bulkApproveMembers(): __PublicMethodMetaInfo<'POST', {}, BulkApproveMembersRequest$1, BulkApproveMembersRequest, BulkApproveMembersResponse$1, BulkApproveMembersResponse>; declare function bulkBlockMembers(): __PublicMethodMetaInfo<'POST', {}, BulkBlockMembersRequest$1, BulkBlockMembersRequest, BulkBlockMembersResponse$1, BulkBlockMembersResponse>; declare function createMember(): __PublicMethodMetaInfo<'POST', {}, CreateMemberRequest$1, CreateMemberRequest, CreateMemberResponse$1, CreateMemberResponse>; declare function updateMember(): __PublicMethodMetaInfo<'PATCH', { memberId: string; }, UpdateMemberRequest$1, UpdateMemberRequest, UpdateMemberResponse$1, UpdateMemberResponse>; declare function deleteMemberPhones(): __PublicMethodMetaInfo<'DELETE', { id: string; }, DeleteMemberPhonesRequest$1, DeleteMemberPhonesRequest, DeleteMemberPhonesResponse$1, DeleteMemberPhonesResponse>; declare function deleteMemberEmails(): __PublicMethodMetaInfo<'DELETE', { id: string; }, DeleteMemberEmailsRequest$1, DeleteMemberEmailsRequest, DeleteMemberEmailsResponse$1, DeleteMemberEmailsResponse>; declare function deleteMemberAddresses(): __PublicMethodMetaInfo<'DELETE', { id: string; }, DeleteMemberAddressesRequest$1, DeleteMemberAddressesRequest, DeleteMemberAddressesResponse$1, DeleteMemberAddressesResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ActiveSubscriptionMemberBlockForbiddenPayload as ActiveSubscriptionMemberBlockForbiddenPayloadOriginal, type ActiveSubscriptionMemberDeleteForbiddenPayload as ActiveSubscriptionMemberDeleteForbiddenPayloadOriginal, ActivityStatusStatus as ActivityStatusStatusOriginal, type ActivityStatusStatusWithLiterals as ActivityStatusStatusWithLiteralsOriginal, type Address as AddressOriginal, type AddressStreetOneOf as AddressStreetOneOfOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type ApproveMemberRequest as ApproveMemberRequestOriginal, type ApproveMemberResponse as ApproveMemberResponseOriginal, type Asset as AssetOriginal, type BlockMemberApplicationErrors as BlockMemberApplicationErrorsOriginal, type BlockMemberRequest as BlockMemberRequestOriginal, type BlockMemberResponse as BlockMemberResponseOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkApproveMembersRequest as BulkApproveMembersRequestOriginal, type BulkApproveMembersResponse as BulkApproveMembersResponseOriginal, type BulkBlockMembersRequest as BulkBlockMembersRequestOriginal, type BulkBlockMembersResponse as BulkBlockMembersResponseOriginal, type BulkDeleteMembersByFilterRequest as BulkDeleteMembersByFilterRequestOriginal, type BulkDeleteMembersByFilterResponse as BulkDeleteMembersByFilterResponseOriginal, type BulkDeleteMembersRequest as BulkDeleteMembersRequestOriginal, type BulkDeleteMembersResponse as BulkDeleteMembersResponseOriginal, type BulkMemberResult as BulkMemberResultOriginal, type Contact as ContactOriginal, type ContentDeletionRequested as ContentDeletionRequestedOriginal, type ContentReassignmentRequested as ContentReassignmentRequestedOriginal, type CreateMemberRequest as CreateMemberRequestOriginal, type CreateMemberResponse as CreateMemberResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type CustomField as CustomFieldOriginal, type CustomTag as CustomTagOriginal, type DeleteContext as DeleteContextOriginal, type DeleteMemberAddressesRequest as DeleteMemberAddressesRequestOriginal, type DeleteMemberAddressesResponse as DeleteMemberAddressesResponseOriginal, type DeleteMemberEmailsRequest as DeleteMemberEmailsRequestOriginal, type DeleteMemberEmailsResponse as DeleteMemberEmailsResponseOriginal, type DeleteMemberPhonesRequest as DeleteMemberPhonesRequestOriginal, type DeleteMemberPhonesResponse as DeleteMemberPhonesResponseOriginal, type DeleteMemberRequest as DeleteMemberRequestOriginal, type DeleteMemberResponse as DeleteMemberResponseOriginal, type DeleteMemberValidationErrors as DeleteMemberValidationErrorsOriginal, type DeleteMyMemberRequest as DeleteMyMemberRequestOriginal, type DeleteMyMemberResponse as DeleteMyMemberResponseOriginal, type DeleteMyMemberValidationErrors as DeleteMyMemberValidationErrorsOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DisconnectMemberRequest as DisconnectMemberRequestOriginal, type DisconnectMemberResponse as DisconnectMemberResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type File as FileOriginal, type GetMemberApplicationErrors as GetMemberApplicationErrorsOriginal, type GetMemberRequest as GetMemberRequestOriginal, type GetMemberResponse as GetMemberResponseOriginal, type GetMyMemberApplicationErrors as GetMyMemberApplicationErrorsOriginal, type GetMyMemberRequest as GetMyMemberRequestOriginal, type GetMyMemberResponse as GetMyMemberResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidCustomFieldUrlPayload as InvalidCustomFieldUrlPayloadOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type JoinCommunityApplicationErrors as JoinCommunityApplicationErrorsOriginal, type JoinCommunityRequest as JoinCommunityRequestOriginal, type JoinCommunityResponse as JoinCommunityResponseOriginal, type LeaveCommunityRequest as LeaveCommunityRequestOriginal, type LeaveCommunityResponse as LeaveCommunityResponseOriginal, type ListMembersRequest as ListMembersRequestOriginal, type ListMembersResponse as ListMembersResponseOriginal, type MemberApproved as MemberApprovedOriginal, type MemberBlocked as MemberBlockedOriginal, type MemberIdChanged as MemberIdChangedOriginal, type MemberJoinedCommunity as MemberJoinedCommunityOriginal, type MemberLeftCommunity as MemberLeftCommunityOriginal, type MemberMuted as MemberMutedOriginal, type Member as MemberOriginal, type MemberOwnershipTransferred as MemberOwnershipTransferredOriginal, type MemberSelfBlockForbiddenPayload as MemberSelfBlockForbiddenPayloadOriginal, type MemberToMemberBlockedPayload as MemberToMemberBlockedPayloadOriginal, type MemberUnmuted as MemberUnmutedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MuteMemberRequest as MuteMemberRequestOriginal, type MuteMemberResponse as MuteMemberResponseOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type OwnerMemberBlockForbiddenPayload as OwnerMemberBlockForbiddenPayloadOriginal, type OwnerOrContributorDeleteForbiddenPayload as OwnerOrContributorDeleteForbiddenPayloadOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type PagingMetadata as PagingMetadataOriginal, type Paging as PagingOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, PrivacyStatusStatus as PrivacyStatusStatusOriginal, type PrivacyStatusStatusWithLiterals as PrivacyStatusStatusWithLiteralsOriginal, type Profile as ProfileOriginal, type QueryMembersRequest as QueryMembersRequestOriginal, type QueryMembersResponse as QueryMembersResponseOriginal, type Query as QueryOriginal, type RestoreInfo as RestoreInfoOriginal, type Search as SearchOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, Set as SetOriginal, type SetWithLiterals as SetWithLiteralsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, type SlugAlreadyExistsPayload as SlugAlreadyExistsPayloadOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UnmuteMemberRequest as UnmuteMemberRequestOriginal, type UnmuteMemberResponse as UnmuteMemberResponseOriginal, type UpdateMemberRequest as UpdateMemberRequestOriginal, type UpdateMemberResponse as UpdateMemberResponseOriginal, type UpdateMemberSlugApplicationErrors as UpdateMemberSlugApplicationErrorsOriginal, type UpdateMemberSlugRequest as UpdateMemberSlugRequestOriginal, type UpdateMemberSlugResponse as UpdateMemberSlugResponseOriginal, type UpdateMemberValidationErrors as UpdateMemberValidationErrorsOriginal, type UpdateMySlugApplicationErrors as UpdateMySlugApplicationErrorsOriginal, type UpdateMySlugRequest as UpdateMySlugRequestOriginal, type UpdateMySlugResponse as UpdateMySlugResponseOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, approveMember, blockMember, bulkApproveMembers, bulkBlockMembers, bulkDeleteMembers, bulkDeleteMembersByFilter, createMember, deleteMember, deleteMemberAddresses, deleteMemberEmails, deleteMemberPhones, deleteMyMember, disconnectMember, getCurrentMember, getMember, joinCommunity, leaveCommunity, listMembers, muteMember, queryMembers, unmuteMember, updateCurrentMemberSlug, updateMember, updateMemberSlug };