declare module "wix-members.v3" { /** * A Badge is a a visible label to be displayed on a site member's profile. * You can use badges to create specific categories of members within your site. * Read more about Badges * in this [article](https://support.wix.com/en/article/about-member-badges). */ interface Badge { /** * Badge ID. * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the Badge is updated. * To prevent conflicting changes, * the current revision must be passed when updating the Badge. * Ignored when creating a Badge. * @readonly */ revision?: string | null; /** Text displayed on the badge in the Wix UI. */ title?: string | null; /** Badge description. */ description?: string | null; /** * Badge background color in hexadecimal RGB format. * Uppercase letters only. * Example: `#FFFFFF`. */ backgroundColor?: string | null; /** * Badge text color in hexadecimal RGB format. * Uppercase letters only. * Example: `#C81B53`. */ textColor?: string | null; /** * Badge icon image. * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale. */ icon?: string; /** * Whether the badge has special permissions * to access specific members-only pages. * When `true`, members with the badge receive special permissions, * and site contributors can * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge) * in the site dashboard. * When `false`, members with the badge receive no special permissions. */ permissionsEnabled?: boolean | null; /** * Slugified name. Used to represent the badge in a URL. * @readonly */ slug?: string | null; /** * Date and time the Badge was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the Badge was last updated. * @readonly */ _updatedDate?: Date | null; } interface CreateBadgeRequest { /** Badge to create. */ badge: Badge; } interface CreateBadgeResponse { /** Created badge. */ badge?: Badge; } interface GetBadgeRequest { /** Badge ID. */ badgeId: string; } interface GetBadgeResponse { /** Badge. */ badge?: Badge; } interface QueryBadgesRequest { /** CursorQuery from protodep */ query?: CursorQuery$1; } interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$3; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting$3[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf$1 { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$3; } interface Sorting$3 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$3; } enum SortOrder$3 { ASC = "ASC", DESC = "DESC" } interface CursorPaging$3 { /** Number of items to load. */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * You can get the relevant cursor token * from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. */ cursor?: string | null; } interface QueryBadgesResponse { /** List of badges. */ badges?: Badge[]; /** Metadata for the paginated results. */ pagingMetadata?: CursorPagingMetadata$1; } interface CursorPagingMetadata$1 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ cursors?: Cursors$3; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. */ hasNext?: boolean | null; } interface Cursors$3 { /** Cursor pointing to next page in the list of results. */ next?: string | null; /** Cursor pointing to previous page in the list of results. */ prev?: string | null; } interface QueryBadgesLegacyRequest { /** Filter criteria */ filter?: Record | null; /** Sorting criteria */ sort?: Sorting$3[]; /** Result paging data */ paging?: Paging$3; } interface Paging$3 { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface QueryBadgesLegacyResponse { /** List of sorted badges in a site that satisfy filter and paging */ badges?: Badge[]; /** Total count of badges in a site that satisfy given filter */ metadata?: PagingMetadata$2; } interface PagingMetadata$2 { /** 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; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface UpdateBadgeRequest { /** Badge to update. */ badge: Badge; } interface UpdateBadgeResponse { /** Updated badge. */ badge?: Badge; } interface DeleteBadgeRequest { /** Badge ID. */ badgeId: string; } interface DeleteBadgeResponse { } interface UpdateBadgesDisplayOrderRequest { /** Ordered badge IDs. */ ids: string[]; } interface UpdateBadgesDisplayOrderResponse { /** Reordered badges list. */ badges?: Badge[]; } interface DomainEvent$4 extends DomainEventBodyOneOf$4 { createdEvent?: EntityCreatedEvent$4; updatedEvent?: EntityUpdatedEvent$4; deletedEvent?: EntityDeletedEvent$4; actionEvent?: ActionEvent$4; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * 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 defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf$4 { createdEvent?: EntityCreatedEvent$4; updatedEvent?: EntityUpdatedEvent$4; deletedEvent?: EntityDeletedEvent$4; actionEvent?: ActionEvent$4; } interface EntityCreatedEvent$4 { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo$3; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo$3 { deletedDate?: Date | null; } interface EntityUpdatedEvent$4 { /** * 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; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * WIP - This property will hold both names and values of the updated fields of the entity. * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363) * @internal */ modifiedFields?: Record; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent$4 { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted */ deletedEntityAsJson?: string | null; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent$4 { bodyAsJson?: string; } interface MessageEnvelope$3 { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData$3; /** Stringify payload. */ data?: string; } interface IdentificationData$3 extends IdentificationDataIdOneOf$3 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType$3; } /** @oneof */ interface IdentificationDataIdOneOf$3 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } enum WebhookIdentityType$3 { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** * Creates a new Badge. * @param badge - Badge to create. * @internal * @documentationMaturity preview * @requiredField badge * @requiredField badge.title * @permissionId BADGES.BADGE_CREATE * @adminMethod * @returns Created badge. */ function createBadge(badge: Badge): Promise; /** * Retrieves a Badge. * @param badgeId - Badge ID. * @internal * @documentationMaturity preview * @requiredField badgeId * @permissionId BADGES.BADGE_READ * @returns Badge. */ function getBadge(badgeId: string): Promise; /** * Retrieves up to 1000 badges, given the requested query options, paging, and sorting. * Default `paging.limit` is 100, `paging.offset` - 0. * For more information, see * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section). * @internal * @documentationMaturity preview * @permissionId BADGES.BADGE_READ */ function queryBadges(): BadgesQueryBuilder; interface QueryOffsetResult { currentPage: number | undefined; totalPages: number | undefined; totalCount: number | undefined; hasNext: () => boolean; hasPrev: () => boolean; length: number; pageSize: number; } interface BadgesQueryResult extends QueryOffsetResult { items: Badge[]; query: BadgesQueryBuilder; next: () => Promise; prev: () => Promise; } interface BadgesQueryBuilder { /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ eq: (propertyName: '_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug', value: any) => BadgesQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ne: (propertyName: '_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug', value: any) => BadgesQueryBuilder; /** @param propertyName - Property whose value is compared with `string`. * @param string - String to compare against. Case-insensitive. * @documentationMaturity preview */ startsWith: (propertyName: '_id' | 'title' | 'description' | 'slug', value: string) => BadgesQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. * @documentationMaturity preview */ hasSome: (propertyName: '_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug', value: any[]) => BadgesQueryBuilder; /** @documentationMaturity preview */ in: (propertyName: '_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug', value: any) => BadgesQueryBuilder; /** @documentationMaturity preview */ exists: (propertyName: '_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug', value: boolean) => BadgesQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ ascending: (...propertyNames: Array<'_id' | 'title' | 'description' | 'permissionsEnabled' | 'slug'>) => BadgesQueryBuilder; /** @param limit - Number of items to return, which is also the `pageSize` of the results object. * @documentationMaturity preview */ limit: (limit: number) => BadgesQueryBuilder; /** @param skip - Number of items to skip in the query results before returning the results. * @documentationMaturity preview */ skip: (skip: number) => BadgesQueryBuilder; /** @documentationMaturity preview */ find: () => Promise; } /** * Internal Query endpoint to accept requests from BadgesV1-V3, as there we use old Filtering in request * @internal * @documentationMaturity preview * @permissionId BADGES.BADGE_READ */ function queryBadgesLegacy(options?: QueryBadgesLegacyOptions): Promise; interface QueryBadgesLegacyOptions { /** Filter criteria */ filter?: Record | null; /** Sorting criteria */ sort?: Sorting$3[]; /** Result paging data */ paging?: Paging$3; } /** * Updates a badge's specified properties. * @param _id - Badge ID. * @internal * @documentationMaturity preview * @requiredField _id * @requiredField badge * @permissionId BADGES.BADGE_UPDATE * @adminMethod * @returns Updated badge. */ function updateBadge(_id: string | null, badge: UpdateBadge): Promise; interface UpdateBadge { /** * Badge ID. * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the Badge is updated. * To prevent conflicting changes, * the current revision must be passed when updating the Badge. * Ignored when creating a Badge. * @readonly */ revision?: string | null; /** Text displayed on the badge in the Wix UI. */ title?: string | null; /** Badge description. */ description?: string | null; /** * Badge background color in hexadecimal RGB format. * Uppercase letters only. * Example: `#FFFFFF`. */ backgroundColor?: string | null; /** * Badge text color in hexadecimal RGB format. * Uppercase letters only. * Example: `#C81B53`. */ textColor?: string | null; /** * Badge icon image. * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale. */ icon?: string; /** * Whether the badge has special permissions * to access specific members-only pages. * When `true`, members with the badge receive special permissions, * and site contributors can * [manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge) * in the site dashboard. * When `false`, members with the badge receive no special permissions. */ permissionsEnabled?: boolean | null; /** * Slugified name. Used to represent the badge in a URL. * @readonly */ slug?: string | null; /** * Date and time the Badge was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the Badge was last updated. * @readonly */ _updatedDate?: Date | null; } /** * Deletes a badge. * @param badgeId - Badge ID. * @internal * @documentationMaturity preview * @requiredField badgeId * @permissionId BADGES.BADGE_DELETE * @adminMethod */ function deleteBadge(badgeId: string): Promise; /** * Updates badges' display order. * @param ids - Ordered badge IDs. * @internal * @documentationMaturity preview * @requiredField ids * @permissionId BADGES.BADGE_UPDATE_DISPLAY_ORDER * @adminMethod */ function updateBadgesDisplayOrder(ids: string[]): Promise; type badgesV4Badge_universal_d_Badge = Badge; type badgesV4Badge_universal_d_CreateBadgeRequest = CreateBadgeRequest; type badgesV4Badge_universal_d_CreateBadgeResponse = CreateBadgeResponse; type badgesV4Badge_universal_d_GetBadgeRequest = GetBadgeRequest; type badgesV4Badge_universal_d_GetBadgeResponse = GetBadgeResponse; type badgesV4Badge_universal_d_QueryBadgesRequest = QueryBadgesRequest; type badgesV4Badge_universal_d_QueryBadgesResponse = QueryBadgesResponse; type badgesV4Badge_universal_d_QueryBadgesLegacyRequest = QueryBadgesLegacyRequest; type badgesV4Badge_universal_d_QueryBadgesLegacyResponse = QueryBadgesLegacyResponse; type badgesV4Badge_universal_d_UpdateBadgeRequest = UpdateBadgeRequest; type badgesV4Badge_universal_d_UpdateBadgeResponse = UpdateBadgeResponse; type badgesV4Badge_universal_d_DeleteBadgeRequest = DeleteBadgeRequest; type badgesV4Badge_universal_d_DeleteBadgeResponse = DeleteBadgeResponse; type badgesV4Badge_universal_d_UpdateBadgesDisplayOrderRequest = UpdateBadgesDisplayOrderRequest; type badgesV4Badge_universal_d_UpdateBadgesDisplayOrderResponse = UpdateBadgesDisplayOrderResponse; const badgesV4Badge_universal_d_createBadge: typeof createBadge; const badgesV4Badge_universal_d_getBadge: typeof getBadge; const badgesV4Badge_universal_d_queryBadges: typeof queryBadges; type badgesV4Badge_universal_d_BadgesQueryResult = BadgesQueryResult; type badgesV4Badge_universal_d_BadgesQueryBuilder = BadgesQueryBuilder; const badgesV4Badge_universal_d_queryBadgesLegacy: typeof queryBadgesLegacy; type badgesV4Badge_universal_d_QueryBadgesLegacyOptions = QueryBadgesLegacyOptions; const badgesV4Badge_universal_d_updateBadge: typeof updateBadge; type badgesV4Badge_universal_d_UpdateBadge = UpdateBadge; const badgesV4Badge_universal_d_deleteBadge: typeof deleteBadge; const badgesV4Badge_universal_d_updateBadgesDisplayOrder: typeof updateBadgesDisplayOrder; namespace badgesV4Badge_universal_d { export { badgesV4Badge_universal_d_Badge as Badge, badgesV4Badge_universal_d_CreateBadgeRequest as CreateBadgeRequest, badgesV4Badge_universal_d_CreateBadgeResponse as CreateBadgeResponse, badgesV4Badge_universal_d_GetBadgeRequest as GetBadgeRequest, badgesV4Badge_universal_d_GetBadgeResponse as GetBadgeResponse, badgesV4Badge_universal_d_QueryBadgesRequest as QueryBadgesRequest, CursorQuery$1 as CursorQuery, CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, Sorting$3 as Sorting, SortOrder$3 as SortOrder, CursorPaging$3 as CursorPaging, badgesV4Badge_universal_d_QueryBadgesResponse as QueryBadgesResponse, CursorPagingMetadata$1 as CursorPagingMetadata, Cursors$3 as Cursors, badgesV4Badge_universal_d_QueryBadgesLegacyRequest as QueryBadgesLegacyRequest, Paging$3 as Paging, badgesV4Badge_universal_d_QueryBadgesLegacyResponse as QueryBadgesLegacyResponse, PagingMetadata$2 as PagingMetadata, badgesV4Badge_universal_d_UpdateBadgeRequest as UpdateBadgeRequest, badgesV4Badge_universal_d_UpdateBadgeResponse as UpdateBadgeResponse, badgesV4Badge_universal_d_DeleteBadgeRequest as DeleteBadgeRequest, badgesV4Badge_universal_d_DeleteBadgeResponse as DeleteBadgeResponse, badgesV4Badge_universal_d_UpdateBadgesDisplayOrderRequest as UpdateBadgesDisplayOrderRequest, badgesV4Badge_universal_d_UpdateBadgesDisplayOrderResponse as UpdateBadgesDisplayOrderResponse, DomainEvent$4 as DomainEvent, DomainEventBodyOneOf$4 as DomainEventBodyOneOf, EntityCreatedEvent$4 as EntityCreatedEvent, RestoreInfo$3 as RestoreInfo, EntityUpdatedEvent$4 as EntityUpdatedEvent, EntityDeletedEvent$4 as EntityDeletedEvent, ActionEvent$4 as ActionEvent, MessageEnvelope$3 as MessageEnvelope, IdentificationData$3 as IdentificationData, IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, WebhookIdentityType$3 as WebhookIdentityType, badgesV4Badge_universal_d_createBadge as createBadge, badgesV4Badge_universal_d_getBadge as getBadge, badgesV4Badge_universal_d_queryBadges as queryBadges, badgesV4Badge_universal_d_BadgesQueryResult as BadgesQueryResult, badgesV4Badge_universal_d_BadgesQueryBuilder as BadgesQueryBuilder, badgesV4Badge_universal_d_queryBadgesLegacy as queryBadgesLegacy, badgesV4Badge_universal_d_QueryBadgesLegacyOptions as QueryBadgesLegacyOptions, badgesV4Badge_universal_d_updateBadge as updateBadge, badgesV4Badge_universal_d_UpdateBadge as UpdateBadge, badgesV4Badge_universal_d_deleteBadge as deleteBadge, badgesV4Badge_universal_d_updateBadgesDisplayOrder as updateBadgesDisplayOrder, }; } interface UserMember { /** * Profile id. * @readonly */ memberId?: string | null; /** * User id. * @readonly */ userId?: string | null; /** * Contact id. * @readonly */ contactId?: string | null; /** * The instance id of the 'SiteMembers' app. * @readonly */ siteMembersInstanceId?: string | null; /** * The id of the meta site * @readonly */ metaSiteId?: string | null; /** Photo picture, which is used as a profile picture. */ photo?: Image; /** * Nickname. * @readonly */ nickname?: string | null; /** * Member profile privacy status. * @readonly */ privacyStatus?: PrivacyStatusStatus; /** * Member created timestamp. * @readonly */ _createdDate?: Date | null; /** * Last member updated timestamp. * @readonly */ _updatedDate?: Date | null; /** * Status, e.g. approved/blocked/... * @readonly */ status?: Status; /** * Member activity status. * @readonly */ activityStatus?: ActivityStatusStatus; } 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; } enum PrivacyStatusStatus { UNKNOWN = "UNKNOWN", PRIVATE = "PRIVATE", PUBLIC = "PUBLIC" } enum Status { UNKNOWN = "UNKNOWN", PENDING = "PENDING", APPROVED = "APPROVED", BLOCKED = "BLOCKED", OFFLINE = "OFFLINE" } enum ActivityStatusStatus { UNKNOWN = "UNKNOWN", ACTIVE = "ACTIVE", MUTED = "MUTED" } interface QueryUserMembersRequest { query?: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$2; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting$2[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$2; } interface Sorting$2 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$2; } enum SortOrder$2 { ASC = "ASC", DESC = "DESC" } interface CursorPaging$2 { /** Number of items to load. */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * You can get the relevant cursor token * from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. */ cursor?: string | null; } interface QueryUserMembersResponse { userMembers?: UserMember[]; metadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors$2; /** * 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; /** * Total number of items matching the filter. * Available only on the first page of *Search* results, not included in *Query* or *List* results. * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page. * @internal */ total?: number | null; } interface Cursors$2 { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface DomainEvent$3 extends DomainEventBodyOneOf$3 { createdEvent?: EntityCreatedEvent$3; updatedEvent?: EntityUpdatedEvent$3; deletedEvent?: EntityDeletedEvent$3; actionEvent?: ActionEvent$3; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * 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 defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf$3 { createdEvent?: EntityCreatedEvent$3; updatedEvent?: EntityUpdatedEvent$3; deletedEvent?: EntityDeletedEvent$3; actionEvent?: ActionEvent$3; } interface EntityCreatedEvent$3 { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo$2; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo$2 { deletedDate?: Date | null; } interface EntityUpdatedEvent$3 { /** * 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; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * WIP - This property will hold both names and previous values of the updated fields of the entity. * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363) * @internal */ modifiedFields?: Record; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent$3 { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted */ deletedEntityAsJson?: string | null; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent$3 { bodyAsJson?: string; } interface Empty$4 { } interface MetaSiteSpecialEvent$2 extends MetaSiteSpecialEventPayloadOneOf$2 { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated$2; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred$2; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted$2; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted$2; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished$2; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished$2; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate$2; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite$2; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned$2; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved$2; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed$2; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted$2; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged$2; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned$2; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned$2; /** A meta site id. */ 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 */ assets?: Asset$2[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf$2 { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated$2; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred$2; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted$2; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted$2; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished$2; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished$2; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate$2; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite$2; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned$2; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved$2; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed$2; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted$2; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged$2; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned$2; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned$2; } interface Asset$2 { /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */ appDefId?: string; /** An instance id. For legacy reasons may be UUID or a string. */ instanceId?: string; /** An application state. */ state?: State$2; } enum State$2 { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } interface SiteCreated$2 { /** A template identifier (empty if not created from a template). */ originTemplateId?: string; /** An account id of the owner. */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContext$2; /** * 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. */ originMetaSiteId?: string | null; /** A meta site name (URL slug). */ siteName?: string; /** A namespace. */ namespace?: Namespace$2; } enum SiteCreatedContext$2 { /** 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" } enum Namespace$2 { 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" } /** Site transferred to another user. */ interface SiteTransferred$2 { /** A previous owner id (user that transfers meta site). */ oldOwnerId?: string; /** A new owner id (user that accepts meta site). */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted$2 { /** A deletion context. */ deleteContext?: DeleteContext$2; } interface DeleteContext$2 { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatus$2; /** A reason (flow). */ deleteOrigin?: string; /** A service that deleted it. */ initiatorId?: string | null; } enum DeleteStatus$2 { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE" } /** Restoration of the meta site. */ interface SiteUndeleted$2 { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished$2 { } interface SiteUnpublished$2 { /** A list of URLs previously associated with the meta site. */ urls?: string[]; } interface SiteMarkedAsTemplate$2 { } interface SiteMarkedAsWixSite$2 { } /** * 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$2 { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** An instance id from which this instance is originated. */ originInstanceId?: string; /** A version. */ version?: string | null; /** The origin meta site id */ originMetaSiteId?: string | null; } interface ServiceRemoved$2 { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** A version. */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed$2 { /** A new meta site name (URL slug). */ newSiteName?: string; /** A previous meta site name (URL slug). */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted$2 { /** A deletion context. */ deleteContext?: DeleteContext$2; } interface NamespaceChanged$2 { /** A previous namespace. */ oldNamespace?: Namespace$2; /** A new namespace. */ newNamespace?: Namespace$2; } /** Assigned Studio editor */ interface StudioAssigned$2 { } /** Unassigned Studio editor */ interface StudioUnassigned$2 { } /** * Retrieves a list of user members, based on provided filters, sorting and paging. * @public * @documentationMaturity preview * @permissionId MEMBERS.USER_MEMBER_READ * @adminMethod */ function queryUserMembers(): UserMembersQueryBuilder; interface QueryCursorResult { cursors: Cursors$2; hasNext: () => boolean; hasPrev: () => boolean; length: number; pageSize: number; } interface UserMembersQueryResult extends QueryCursorResult { items: UserMember[]; query: UserMembersQueryBuilder; next: () => Promise; prev: () => Promise; } interface UserMembersQueryBuilder { /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ eq: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: any) => UserMembersQueryBuilder; /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. * @documentationMaturity preview */ ne: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: any) => UserMembersQueryBuilder; /** @param propertyName - Property whose value is compared with `string`. * @param string - String to compare against. Case-insensitive. * @documentationMaturity preview */ startsWith: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: string) => UserMembersQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. * @documentationMaturity preview */ hasSome: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: any[]) => UserMembersQueryBuilder; /** @documentationMaturity preview */ in: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: any) => UserMembersQueryBuilder; /** @documentationMaturity preview */ exists: (propertyName: 'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId', value: boolean) => UserMembersQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ ascending: (...propertyNames: Array<'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId'>) => UserMembersQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. * @documentationMaturity preview */ descending: (...propertyNames: Array<'memberId' | 'userId' | 'siteMembersInstanceId' | 'metaSiteId'>) => UserMembersQueryBuilder; /** @param limit - Number of items to return, which is also the `pageSize` of the results object. * @documentationMaturity preview */ limit: (limit: number) => UserMembersQueryBuilder; /** @param cursor - A pointer to specific record * @documentationMaturity preview */ skipTo: (cursor: string) => UserMembersQueryBuilder; /** @documentationMaturity preview */ find: () => Promise; } type membersUsermembersV1UserMember_universal_d_UserMember = UserMember; type membersUsermembersV1UserMember_universal_d_Image = Image; type membersUsermembersV1UserMember_universal_d_PrivacyStatusStatus = PrivacyStatusStatus; const membersUsermembersV1UserMember_universal_d_PrivacyStatusStatus: typeof PrivacyStatusStatus; type membersUsermembersV1UserMember_universal_d_Status = Status; const membersUsermembersV1UserMember_universal_d_Status: typeof Status; type membersUsermembersV1UserMember_universal_d_ActivityStatusStatus = ActivityStatusStatus; const membersUsermembersV1UserMember_universal_d_ActivityStatusStatus: typeof ActivityStatusStatus; type membersUsermembersV1UserMember_universal_d_QueryUserMembersRequest = QueryUserMembersRequest; type membersUsermembersV1UserMember_universal_d_CursorQuery = CursorQuery; type membersUsermembersV1UserMember_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf; type membersUsermembersV1UserMember_universal_d_QueryUserMembersResponse = QueryUserMembersResponse; type membersUsermembersV1UserMember_universal_d_CursorPagingMetadata = CursorPagingMetadata; const membersUsermembersV1UserMember_universal_d_queryUserMembers: typeof queryUserMembers; type membersUsermembersV1UserMember_universal_d_UserMembersQueryResult = UserMembersQueryResult; type membersUsermembersV1UserMember_universal_d_UserMembersQueryBuilder = UserMembersQueryBuilder; namespace membersUsermembersV1UserMember_universal_d { export { membersUsermembersV1UserMember_universal_d_UserMember as UserMember, membersUsermembersV1UserMember_universal_d_Image as Image, membersUsermembersV1UserMember_universal_d_PrivacyStatusStatus as PrivacyStatusStatus, membersUsermembersV1UserMember_universal_d_Status as Status, membersUsermembersV1UserMember_universal_d_ActivityStatusStatus as ActivityStatusStatus, membersUsermembersV1UserMember_universal_d_QueryUserMembersRequest as QueryUserMembersRequest, membersUsermembersV1UserMember_universal_d_CursorQuery as CursorQuery, membersUsermembersV1UserMember_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, Sorting$2 as Sorting, SortOrder$2 as SortOrder, CursorPaging$2 as CursorPaging, membersUsermembersV1UserMember_universal_d_QueryUserMembersResponse as QueryUserMembersResponse, membersUsermembersV1UserMember_universal_d_CursorPagingMetadata as CursorPagingMetadata, Cursors$2 as Cursors, DomainEvent$3 as DomainEvent, DomainEventBodyOneOf$3 as DomainEventBodyOneOf, EntityCreatedEvent$3 as EntityCreatedEvent, RestoreInfo$2 as RestoreInfo, EntityUpdatedEvent$3 as EntityUpdatedEvent, EntityDeletedEvent$3 as EntityDeletedEvent, ActionEvent$3 as ActionEvent, Empty$4 as Empty, MetaSiteSpecialEvent$2 as MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf$2 as MetaSiteSpecialEventPayloadOneOf, Asset$2 as Asset, State$2 as State, SiteCreated$2 as SiteCreated, SiteCreatedContext$2 as SiteCreatedContext, Namespace$2 as Namespace, SiteTransferred$2 as SiteTransferred, SiteDeleted$2 as SiteDeleted, DeleteContext$2 as DeleteContext, DeleteStatus$2 as DeleteStatus, SiteUndeleted$2 as SiteUndeleted, SitePublished$2 as SitePublished, SiteUnpublished$2 as SiteUnpublished, SiteMarkedAsTemplate$2 as SiteMarkedAsTemplate, SiteMarkedAsWixSite$2 as SiteMarkedAsWixSite, ServiceProvisioned$2 as ServiceProvisioned, ServiceRemoved$2 as ServiceRemoved, SiteRenamed$2 as SiteRenamed, SiteHardDeleted$2 as SiteHardDeleted, NamespaceChanged$2 as NamespaceChanged, StudioAssigned$2 as StudioAssigned, StudioUnassigned$2 as StudioUnassigned, membersUsermembersV1UserMember_universal_d_queryUserMembers as queryUserMembers, membersUsermembersV1UserMember_universal_d_UserMembersQueryResult as UserMembersQueryResult, membersUsermembersV1UserMember_universal_d_UserMembersQueryBuilder as UserMembersQueryBuilder, }; } /** Custom field */ interface CustomField { /** * Field ID. * @readonly */ _id?: string | null; /** Human-readable name shown in the business manager and live site. */ name?: string | null; /** * Field key. * @readonly */ key?: string | null; /** Default privacy of custom field. */ defaultPrivacy?: Privacy$2; /** Type of data the field holds. */ fieldType?: Type$1; /** Social field type. */ socialType?: SocialTypeType$1; /** * Field origin. * @readonly */ fieldOrigin?: Origin$1; /** * Describes whom the custom field applies to. * @readonly */ appliesTo?: AppliesTo; /** * The section the field belongs to. * @readonly */ section?: Section; /** * Date and time when the field was created. * @readonly */ _createdDate?: Date | null; /** * Date and time when the field was updated. * @readonly */ _updatedDate?: Date | null; /** Revision number, used for checking the optimistic lock condition. */ revision?: string | null; } enum Privacy$2 { UNKNOWN = "UNKNOWN", PUBLIC = "PUBLIC", PRIVATE = "PRIVATE" } enum Type$1 { UNKNOWN = "UNKNOWN", TEXT = "TEXT", NUMBER = "NUMBER", DATE = "DATE", URL = "URL", SOCIAL = "SOCIAL" } enum SocialTypeType$1 { UNKNOWN = "UNKNOWN", FACEBOOK = "FACEBOOK", INSTAGRAM = "INSTAGRAM", LINKEDIN = "LINKEDIN", TWITTER = "TWITTER", YOUTUBE = "YOUTUBE", PINTEREST = "PINTEREST", TIKTOK = "TIKTOK", DEVIANTART = "DEVIANTART", SOUNDCLOUD = "SOUNDCLOUD", TUMBLR = "TUMBLR", VIMEO = "VIMEO", VKONTAKTE = "VKONTAKTE", ODNOKLASSNIKI = "ODNOKLASSNIKI", OTHER = "OTHER" } enum Origin$1 { UNKNOWN = "UNKNOWN", CUSTOM = "CUSTOM", CONTACT = "CONTACT", SYSTEM = "SYSTEM" } enum AppliesTo { ALL_MEMBERS = "ALL_MEMBERS", SELECTED_MEMBERS = "SELECTED_MEMBERS" } enum Section { GENERAL = "GENERAL", SOCIAL = "SOCIAL", DISPLAY_INFO = "DISPLAY_INFO", ADDRESS = "ADDRESS" } interface CreateCustomFieldRequest { /** Custom field to create. */ field: CustomField; } interface CreateCustomFieldResponse { /** Newly created custom field. */ field?: CustomField; } interface IncorrectFieldTypeData { incorrectType?: Type$1; correctType?: Type$1; } interface IncorrectPrivacyData { incorrectPrivacy?: Privacy$2; correctPrivacy?: Privacy$2; } interface InvalidSocialTypeData { invalidSocialType?: SocialTypeType$1; } interface GetCustomFieldRequest { /** Custom field ID. */ _id: string | null; } interface GetCustomFieldResponse { /** The requested custom field. */ field?: CustomField; } interface ListCustomFieldsRequest { paging?: Paging$2; } interface Paging$2 { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface ListCustomFieldsResponse { fields?: CustomField[]; metadata?: PagingMetadata$1; } interface PagingMetadata$1 { /** 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; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface UpdateCustomFieldRequest { /** Custom field details to update. */ field: CustomField; } interface UpdateCustomFieldResponse { /** Updated custom field. */ field?: CustomField; } interface DefaultPrivacyChanged { fromPrivacy?: Privacy$2; toPrivacy?: Privacy$2; } interface ReservedFieldNameNonEditable { newName?: string; currentName?: string; } interface DeleteCustomFieldRequest { /** ID of the custom field to delete. */ _id: string | null; /** Revision number. */ revision: string | null; } interface DeleteCustomFieldResponse { } interface HideCustomFieldRequest { /** ID of the custom field to hide. */ _id: string | null; /** Revision number. */ revision: string | null; } interface HideCustomFieldResponse { } interface UpdateCustomFieldsOrderRequest { /** Ordered custom field ids. */ fieldIds: string[]; /** The section given fields belong to. */ section?: Section; } interface UpdateCustomFieldsOrderResponse { /** Reordered custom fields. */ fields?: CustomField[]; /** The section given fields belong to. */ section?: Section; } interface MetaSiteSpecialEvent$1 extends MetaSiteSpecialEventPayloadOneOf$1 { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated$1; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred$1; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted$1; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted$1; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished$1; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished$1; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate$1; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite$1; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned$1; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved$1; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed$1; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted$1; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged$1; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned$1; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned$1; /** A meta site id. */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** A list of "assets" (applications). The same as MetaSiteContext. */ assets?: Asset$1[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf$1 { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated$1; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred$1; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted$1; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted$1; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished$1; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished$1; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate$1; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite$1; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned$1; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved$1; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed$1; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted$1; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged$1; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned$1; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned$1; } interface Asset$1 { /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */ appDefId?: string; /** An instance id. For legacy reasons may be UUID or a string. */ instanceId?: string; /** An application state. */ state?: State$1; } enum State$1 { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } interface SiteCreated$1 { /** A template identifier (empty if not created from a template). */ originTemplateId?: string; /** An account id of the owner. */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContext$1; /** * 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. */ originMetaSiteId?: string | null; /** A meta site name (URL slug). */ siteName?: string; /** A namespace. */ namespace?: Namespace$1; } enum SiteCreatedContext$1 { /** 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" } enum Namespace$1 { 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" } /** Site transferred to another user. */ interface SiteTransferred$1 { /** A previous owner id (user that transfers meta site). */ oldOwnerId?: string; /** A new owner id (user that accepts meta site). */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted$1 { /** A deletion context. */ deleteContext?: DeleteContext$1; } interface DeleteContext$1 { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatus$1; /** A reason (flow). */ deleteOrigin?: string; /** A service that deleted it. */ initiatorId?: string | null; } enum DeleteStatus$1 { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE" } /** Restoration of the meta site. */ interface SiteUndeleted$1 { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished$1 { } interface SiteUnpublished$1 { /** A list of URLs previously associated with the meta site. */ urls?: string[]; } interface SiteMarkedAsTemplate$1 { } interface SiteMarkedAsWixSite$1 { } interface ServiceProvisioned$1 { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** An instance id from which this instance is originated. */ originInstanceId?: string; /** A version. */ version?: string | null; /** The origin meta site id */ originMetaSiteId?: string | null; } interface ServiceRemoved$1 { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** A version. */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed$1 { /** A new meta site name (URL slug). */ newSiteName?: string; /** A previous meta site name (URL slug). */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted$1 { /** A deletion context. */ deleteContext?: DeleteContext$1; } interface NamespaceChanged$1 { /** A previous namespace. */ oldNamespace?: Namespace$1; /** A new namespace. */ newNamespace?: Namespace$1; } /** Assigned Studio editor */ interface StudioAssigned$1 { } /** Unassigned Studio editor */ interface StudioUnassigned$1 { } interface Empty$3 { } interface DomainEvent$2 extends DomainEventBodyOneOf$2 { createdEvent?: EntityCreatedEvent$2; updatedEvent?: EntityUpdatedEvent$2; deletedEvent?: EntityDeletedEvent$2; actionEvent?: ActionEvent$2; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * 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 defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf$2 { createdEvent?: EntityCreatedEvent$2; updatedEvent?: EntityUpdatedEvent$2; deletedEvent?: EntityDeletedEvent$2; actionEvent?: ActionEvent$2; } interface EntityCreatedEvent$2 { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo$1; } interface RestoreInfo$1 { deletedDate?: Date | null; } interface EntityUpdatedEvent$2 { /** * 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; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * WIP - This property will hold both names and values of the updated fields of the entity. * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363) * @internal */ modifiedFields?: Record; } interface EntityDeletedEvent$2 { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted */ deletedEntityAsJson?: string | null; } interface ActionEvent$2 { bodyAsJson?: string; } interface MessageEnvelope$2 { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData$2; /** Stringify payload. */ data?: string; } interface IdentificationData$2 extends IdentificationDataIdOneOf$2 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType$2; } /** @oneof */ interface IdentificationDataIdOneOf$2 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } enum WebhookIdentityType$2 { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** * Creates a custom field. * @param field - Custom field to create. * @public * @documentationMaturity preview * @requiredField field * @requiredField field.name * @permissionId MEMBERS.CUSTOM_FIELDS_CREATE * @adminMethod * @returns Newly created custom field. */ function createCustomField(field: CustomField): Promise; /** * Retrieves a custom field by id. * @param _id - Custom field ID. * @public * @documentationMaturity preview * @requiredField _id * @permissionId MEMBERS.CUSTOM_FIELDS_READ */ function getCustomField(_id: string | null): Promise; /** * Returns ordered custom fields, given the provided paging. * * The fields are ordered by section in such sequence: * - `GENERAL` * - `DISPLAY_INFO` * - `SOCIAL` * The fields within same section are ordered with respect to the saved fields order. * * To modify the order of fields within sections, use [`Update Custom Fields Order`](). * @public * @documentationMaturity preview * @adminMethod */ function listCustomFields(options?: ListCustomFieldsOptions): Promise; interface ListCustomFieldsOptions { paging?: Paging$2; } /** * Updates a custom field. * * Allowed fields to update: * - when `fieldOrigin` is `CUSTOM`: `name`, `defaultPrivacy`, `socialType`. * - when `fieldOrigin` is `CONTACT` or `SYSTEM`: `defaultPrivacy`. * @param _id - Field ID. * @public * @documentationMaturity preview * @requiredField _id * @requiredField field * @requiredField field.revision * @permissionId MEMBERS.CUSTOM_FIELDS_UPDATE * @adminMethod * @returns Updated custom field. */ function updateCustomField(_id: string | null, field: UpdateCustomField): Promise; interface UpdateCustomField { /** * Field ID. * @readonly */ _id?: string | null; /** Human-readable name shown in the business manager and live site. */ name?: string | null; /** * Field key. * @readonly */ key?: string | null; /** Default privacy of custom field. */ defaultPrivacy?: Privacy$2; /** Type of data the field holds. */ fieldType?: Type$1; /** Social field type. */ socialType?: SocialTypeType$1; /** * Field origin. * @readonly */ fieldOrigin?: Origin$1; /** * Describes whom the custom field applies to. * @readonly */ appliesTo?: AppliesTo; /** * The section the field belongs to. * @readonly */ section?: Section; /** * Date and time when the field was created. * @readonly */ _createdDate?: Date | null; /** * Date and time when the field was updated. * @readonly */ _updatedDate?: Date | null; /** Revision number, used for checking the optimistic lock condition. */ revision?: string | null; } /** * Deletes a custom field. * * After this action, related custom field in Contacts List will also be removed. * @param _id - ID of the custom field to delete. * @param revision - Revision number. * @public * @documentationMaturity preview * @requiredField _id * @requiredField revision * @permissionId MEMBERS.CUSTOM_FIELDS_DELETE * @adminMethod */ function deleteCustomField(_id: string | null, revision: string | null): Promise; /** * Hides a custom field. * * Hidden field will be removed from the members custom fields list, yet it will be available as a suggested field to be add later. * * After this action, related contacts custom field will still be available in the Contacts List. * @param _id - ID of the custom field to hide. * @param revision - Revision number. * @public * @documentationMaturity preview * @requiredField _id * @requiredField revision * @permissionId MEMBERS.CUSTOM_FIELDS_HIDE * @adminMethod */ function hideCustomField(_id: string | null, revision: string | null): Promise; /** * Updates custom fields order within a section. * @param fieldIds - Ordered custom field ids. * @public * @documentationMaturity preview * @requiredField fieldIds * @permissionId MEMBERS.CUSTOM_FIELDS_UPDATE * @adminMethod */ function updateCustomFieldsOrder(fieldIds: string[], options?: UpdateCustomFieldsOrderOptions): Promise; interface UpdateCustomFieldsOrderOptions { /** The section given fields belong to. */ section?: Section; } type membersV1CustomField_universal_d_CustomField = CustomField; type membersV1CustomField_universal_d_AppliesTo = AppliesTo; const membersV1CustomField_universal_d_AppliesTo: typeof AppliesTo; type membersV1CustomField_universal_d_Section = Section; const membersV1CustomField_universal_d_Section: typeof Section; type membersV1CustomField_universal_d_CreateCustomFieldRequest = CreateCustomFieldRequest; type membersV1CustomField_universal_d_CreateCustomFieldResponse = CreateCustomFieldResponse; type membersV1CustomField_universal_d_IncorrectFieldTypeData = IncorrectFieldTypeData; type membersV1CustomField_universal_d_IncorrectPrivacyData = IncorrectPrivacyData; type membersV1CustomField_universal_d_InvalidSocialTypeData = InvalidSocialTypeData; type membersV1CustomField_universal_d_GetCustomFieldRequest = GetCustomFieldRequest; type membersV1CustomField_universal_d_GetCustomFieldResponse = GetCustomFieldResponse; type membersV1CustomField_universal_d_ListCustomFieldsRequest = ListCustomFieldsRequest; type membersV1CustomField_universal_d_ListCustomFieldsResponse = ListCustomFieldsResponse; type membersV1CustomField_universal_d_UpdateCustomFieldRequest = UpdateCustomFieldRequest; type membersV1CustomField_universal_d_UpdateCustomFieldResponse = UpdateCustomFieldResponse; type membersV1CustomField_universal_d_DefaultPrivacyChanged = DefaultPrivacyChanged; type membersV1CustomField_universal_d_ReservedFieldNameNonEditable = ReservedFieldNameNonEditable; type membersV1CustomField_universal_d_DeleteCustomFieldRequest = DeleteCustomFieldRequest; type membersV1CustomField_universal_d_DeleteCustomFieldResponse = DeleteCustomFieldResponse; type membersV1CustomField_universal_d_HideCustomFieldRequest = HideCustomFieldRequest; type membersV1CustomField_universal_d_HideCustomFieldResponse = HideCustomFieldResponse; type membersV1CustomField_universal_d_UpdateCustomFieldsOrderRequest = UpdateCustomFieldsOrderRequest; type membersV1CustomField_universal_d_UpdateCustomFieldsOrderResponse = UpdateCustomFieldsOrderResponse; const membersV1CustomField_universal_d_createCustomField: typeof createCustomField; const membersV1CustomField_universal_d_getCustomField: typeof getCustomField; const membersV1CustomField_universal_d_listCustomFields: typeof listCustomFields; type membersV1CustomField_universal_d_ListCustomFieldsOptions = ListCustomFieldsOptions; const membersV1CustomField_universal_d_updateCustomField: typeof updateCustomField; type membersV1CustomField_universal_d_UpdateCustomField = UpdateCustomField; const membersV1CustomField_universal_d_deleteCustomField: typeof deleteCustomField; const membersV1CustomField_universal_d_hideCustomField: typeof hideCustomField; const membersV1CustomField_universal_d_updateCustomFieldsOrder: typeof updateCustomFieldsOrder; type membersV1CustomField_universal_d_UpdateCustomFieldsOrderOptions = UpdateCustomFieldsOrderOptions; namespace membersV1CustomField_universal_d { export { membersV1CustomField_universal_d_CustomField as CustomField, Privacy$2 as Privacy, Type$1 as Type, SocialTypeType$1 as SocialTypeType, Origin$1 as Origin, membersV1CustomField_universal_d_AppliesTo as AppliesTo, membersV1CustomField_universal_d_Section as Section, membersV1CustomField_universal_d_CreateCustomFieldRequest as CreateCustomFieldRequest, membersV1CustomField_universal_d_CreateCustomFieldResponse as CreateCustomFieldResponse, membersV1CustomField_universal_d_IncorrectFieldTypeData as IncorrectFieldTypeData, membersV1CustomField_universal_d_IncorrectPrivacyData as IncorrectPrivacyData, membersV1CustomField_universal_d_InvalidSocialTypeData as InvalidSocialTypeData, membersV1CustomField_universal_d_GetCustomFieldRequest as GetCustomFieldRequest, membersV1CustomField_universal_d_GetCustomFieldResponse as GetCustomFieldResponse, membersV1CustomField_universal_d_ListCustomFieldsRequest as ListCustomFieldsRequest, Paging$2 as Paging, membersV1CustomField_universal_d_ListCustomFieldsResponse as ListCustomFieldsResponse, PagingMetadata$1 as PagingMetadata, membersV1CustomField_universal_d_UpdateCustomFieldRequest as UpdateCustomFieldRequest, membersV1CustomField_universal_d_UpdateCustomFieldResponse as UpdateCustomFieldResponse, membersV1CustomField_universal_d_DefaultPrivacyChanged as DefaultPrivacyChanged, membersV1CustomField_universal_d_ReservedFieldNameNonEditable as ReservedFieldNameNonEditable, membersV1CustomField_universal_d_DeleteCustomFieldRequest as DeleteCustomFieldRequest, membersV1CustomField_universal_d_DeleteCustomFieldResponse as DeleteCustomFieldResponse, membersV1CustomField_universal_d_HideCustomFieldRequest as HideCustomFieldRequest, membersV1CustomField_universal_d_HideCustomFieldResponse as HideCustomFieldResponse, membersV1CustomField_universal_d_UpdateCustomFieldsOrderRequest as UpdateCustomFieldsOrderRequest, membersV1CustomField_universal_d_UpdateCustomFieldsOrderResponse as UpdateCustomFieldsOrderResponse, MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf, Asset$1 as Asset, State$1 as State, SiteCreated$1 as SiteCreated, SiteCreatedContext$1 as SiteCreatedContext, Namespace$1 as Namespace, SiteTransferred$1 as SiteTransferred, SiteDeleted$1 as SiteDeleted, DeleteContext$1 as DeleteContext, DeleteStatus$1 as DeleteStatus, SiteUndeleted$1 as SiteUndeleted, SitePublished$1 as SitePublished, SiteUnpublished$1 as SiteUnpublished, SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate, SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite, ServiceProvisioned$1 as ServiceProvisioned, ServiceRemoved$1 as ServiceRemoved, SiteRenamed$1 as SiteRenamed, SiteHardDeleted$1 as SiteHardDeleted, NamespaceChanged$1 as NamespaceChanged, StudioAssigned$1 as StudioAssigned, StudioUnassigned$1 as StudioUnassigned, Empty$3 as Empty, DomainEvent$2 as DomainEvent, DomainEventBodyOneOf$2 as DomainEventBodyOneOf, EntityCreatedEvent$2 as EntityCreatedEvent, RestoreInfo$1 as RestoreInfo, EntityUpdatedEvent$2 as EntityUpdatedEvent, EntityDeletedEvent$2 as EntityDeletedEvent, ActionEvent$2 as ActionEvent, MessageEnvelope$2 as MessageEnvelope, IdentificationData$2 as IdentificationData, IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, WebhookIdentityType$2 as WebhookIdentityType, membersV1CustomField_universal_d_createCustomField as createCustomField, membersV1CustomField_universal_d_getCustomField as getCustomField, membersV1CustomField_universal_d_listCustomFields as listCustomFields, membersV1CustomField_universal_d_ListCustomFieldsOptions as ListCustomFieldsOptions, membersV1CustomField_universal_d_updateCustomField as updateCustomField, membersV1CustomField_universal_d_UpdateCustomField as UpdateCustomField, membersV1CustomField_universal_d_deleteCustomField as deleteCustomField, membersV1CustomField_universal_d_hideCustomField as hideCustomField, membersV1CustomField_universal_d_updateCustomFieldsOrder as updateCustomFieldsOrder, membersV1CustomField_universal_d_UpdateCustomFieldsOrderOptions as UpdateCustomFieldsOrderOptions, }; } interface CustomFieldSuggestion { /** Human-readable name shown in the business manager and live site. */ name?: string | null; /** Default privacy of custom field. */ defaultPrivacy?: Privacy$1; /** Type of data the field holds. */ fieldType?: Type; /** Social field type. */ socialType?: SocialTypeType; /** Field origin. */ fieldOrigin?: Origin; /** Custom field ID. */ customFieldId?: string | null; } enum Privacy$1 { UNKNOWN = "UNKNOWN", PUBLIC = "PUBLIC", PRIVATE = "PRIVATE" } enum Type { UNKNOWN = "UNKNOWN", TEXT = "TEXT", NUMBER = "NUMBER", DATE = "DATE", URL = "URL", SOCIAL = "SOCIAL" } enum SocialTypeType { UNKNOWN = "UNKNOWN", FACEBOOK = "FACEBOOK", INSTAGRAM = "INSTAGRAM", LINKEDIN = "LINKEDIN", TWITTER = "TWITTER", YOUTUBE = "YOUTUBE", PINTEREST = "PINTEREST", TIKTOK = "TIKTOK", DEVIANTART = "DEVIANTART", SOUNDCLOUD = "SOUNDCLOUD", TUMBLR = "TUMBLR", VIMEO = "VIMEO", VKONTAKTE = "VKONTAKTE", ODNOKLASSNIKI = "ODNOKLASSNIKI", OTHER = "OTHER" } enum Origin { UNKNOWN = "UNKNOWN", CUSTOM = "CUSTOM", CONTACT = "CONTACT", SYSTEM = "SYSTEM" } interface ListCustomFieldSuggestionsRequest { paging?: Paging$1; sorting?: Sorting$1[]; } interface Paging$1 { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface Sorting$1 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$1; /** * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. * * If multiple filters are provided, they are combined with AND operator. * * Example: * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } * @internal */ selectItemsBy?: Record[] | null; } enum SortOrder$1 { ASC = "ASC", DESC = "DESC" } interface ListCustomFieldSuggestionsResponse { /** Custom field suggestion. */ suggestions?: CustomFieldSuggestion[]; 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; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface QueryCustomFieldSuggestionsRequest { query?: Query; } interface Query { /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */ filter?: any; /** Limit number of results */ paging?: Paging$1; /** Sort the results */ sorting?: Sorting$1[]; } interface QueryCustomFieldSuggestionsResponse { /** Custom field suggestion. */ suggestions?: CustomFieldSuggestion[]; metadata?: PagingMetadata; } /** * Returns suggestions of custom fields to add. * @public * @documentationMaturity preview * @permissionId MEMBERS.CUSTOM_FIELDS_SUGGESTIONS_READ * @adminMethod */ function listCustomFieldSuggestions(options?: ListCustomFieldSuggestionsOptions): Promise; interface ListCustomFieldSuggestionsOptions { paging?: Paging$1; sorting?: Sorting$1[]; } /** * Returns suggestions of custom fields to add by specified type. * @public * @documentationMaturity preview * @permissionId MEMBERS.CUSTOM_FIELDS_SUGGESTIONS_READ * @adminMethod */ function queryCustomFieldSuggestions(options?: QueryCustomFieldSuggestionsOptions): Promise; interface QueryCustomFieldSuggestionsOptions { query?: Query; } type membersV1CustomFieldSuggestion_universal_d_CustomFieldSuggestion = CustomFieldSuggestion; type membersV1CustomFieldSuggestion_universal_d_Type = Type; const membersV1CustomFieldSuggestion_universal_d_Type: typeof Type; type membersV1CustomFieldSuggestion_universal_d_SocialTypeType = SocialTypeType; const membersV1CustomFieldSuggestion_universal_d_SocialTypeType: typeof SocialTypeType; type membersV1CustomFieldSuggestion_universal_d_Origin = Origin; const membersV1CustomFieldSuggestion_universal_d_Origin: typeof Origin; type membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsRequest = ListCustomFieldSuggestionsRequest; type membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsResponse = ListCustomFieldSuggestionsResponse; type membersV1CustomFieldSuggestion_universal_d_PagingMetadata = PagingMetadata; type membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsRequest = QueryCustomFieldSuggestionsRequest; type membersV1CustomFieldSuggestion_universal_d_Query = Query; type membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsResponse = QueryCustomFieldSuggestionsResponse; const membersV1CustomFieldSuggestion_universal_d_listCustomFieldSuggestions: typeof listCustomFieldSuggestions; type membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsOptions = ListCustomFieldSuggestionsOptions; const membersV1CustomFieldSuggestion_universal_d_queryCustomFieldSuggestions: typeof queryCustomFieldSuggestions; type membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsOptions = QueryCustomFieldSuggestionsOptions; namespace membersV1CustomFieldSuggestion_universal_d { export { membersV1CustomFieldSuggestion_universal_d_CustomFieldSuggestion as CustomFieldSuggestion, Privacy$1 as Privacy, membersV1CustomFieldSuggestion_universal_d_Type as Type, membersV1CustomFieldSuggestion_universal_d_SocialTypeType as SocialTypeType, membersV1CustomFieldSuggestion_universal_d_Origin as Origin, membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsRequest as ListCustomFieldSuggestionsRequest, Paging$1 as Paging, Sorting$1 as Sorting, SortOrder$1 as SortOrder, membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsResponse as ListCustomFieldSuggestionsResponse, membersV1CustomFieldSuggestion_universal_d_PagingMetadata as PagingMetadata, membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsRequest as QueryCustomFieldSuggestionsRequest, membersV1CustomFieldSuggestion_universal_d_Query as Query, membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsResponse as QueryCustomFieldSuggestionsResponse, membersV1CustomFieldSuggestion_universal_d_listCustomFieldSuggestions as listCustomFieldSuggestions, membersV1CustomFieldSuggestion_universal_d_ListCustomFieldSuggestionsOptions as ListCustomFieldSuggestionsOptions, membersV1CustomFieldSuggestion_universal_d_queryCustomFieldSuggestions as queryCustomFieldSuggestions, membersV1CustomFieldSuggestion_universal_d_QueryCustomFieldSuggestionsOptions as QueryCustomFieldSuggestionsOptions, }; } /** Default privacy status */ interface DefaultPrivacy { /** * Privacy ID. * @readonly */ _id?: string | null; /** Default privacy status in meta site. */ defaultPrivacy?: Privacy; /** Revision number, used for checking the optimistic lock condition. */ revision?: string | null; } enum Privacy { PRIVATE = "PRIVATE", PUBLIC = "PUBLIC" } interface GetDefaultPrivacyStatusRequest { } interface GetDefaultPrivacyStatusResponse { defaultPrivacy?: DefaultPrivacy; } interface SetDefaultPrivacyStatusRequest { defaultPrivacy: DefaultPrivacy; } interface SetDefaultPrivacyStatusResponse { defaultPrivacy?: DefaultPrivacy; } /** * Get metasite default privacy status * @public * @documentationMaturity preview * @permissionId MEMBERS.DEFAULT_PRIVACY_STATUS_READ */ function getDefaultPrivacyStatus(): Promise; /** * Set metasite default privacy status * @public * @documentationMaturity preview * @requiredField defaultPrivacy * @requiredField defaultPrivacy.revision * @permissionId MEMBERS.DEFAULT_PRIVACY_STATUS_WRITE * @adminMethod */ function setDefaultPrivacyStatus(defaultPrivacy: DefaultPrivacy): Promise; type membersV1DefaultPrivacy_universal_d_DefaultPrivacy = DefaultPrivacy; type membersV1DefaultPrivacy_universal_d_Privacy = Privacy; const membersV1DefaultPrivacy_universal_d_Privacy: typeof Privacy; type membersV1DefaultPrivacy_universal_d_GetDefaultPrivacyStatusRequest = GetDefaultPrivacyStatusRequest; type membersV1DefaultPrivacy_universal_d_GetDefaultPrivacyStatusResponse = GetDefaultPrivacyStatusResponse; type membersV1DefaultPrivacy_universal_d_SetDefaultPrivacyStatusRequest = SetDefaultPrivacyStatusRequest; type membersV1DefaultPrivacy_universal_d_SetDefaultPrivacyStatusResponse = SetDefaultPrivacyStatusResponse; const membersV1DefaultPrivacy_universal_d_getDefaultPrivacyStatus: typeof getDefaultPrivacyStatus; const membersV1DefaultPrivacy_universal_d_setDefaultPrivacyStatus: typeof setDefaultPrivacyStatus; namespace membersV1DefaultPrivacy_universal_d { export { membersV1DefaultPrivacy_universal_d_DefaultPrivacy as DefaultPrivacy, membersV1DefaultPrivacy_universal_d_Privacy as Privacy, membersV1DefaultPrivacy_universal_d_GetDefaultPrivacyStatusRequest as GetDefaultPrivacyStatusRequest, membersV1DefaultPrivacy_universal_d_GetDefaultPrivacyStatusResponse as GetDefaultPrivacyStatusResponse, membersV1DefaultPrivacy_universal_d_SetDefaultPrivacyStatusRequest as SetDefaultPrivacyStatusRequest, membersV1DefaultPrivacy_universal_d_SetDefaultPrivacyStatusResponse as SetDefaultPrivacyStatusResponse, membersV1DefaultPrivacy_universal_d_getDefaultPrivacyStatus as getDefaultPrivacyStatus, membersV1DefaultPrivacy_universal_d_setDefaultPrivacyStatus as setDefaultPrivacyStatus, }; } interface MemberReport { /** * Report ID. * @readonly */ _id?: string | null; /** ID of the reported member. */ reportedMemberId?: string; /** * ID of the member who created the report. * @readonly */ reportingMemberId?: string | null; /** Reason for reporting a member. */ reason?: Reason; /** * Date and time the report was created. * @readonly */ _createdDate?: Date | null; } interface Reason { /** Report reason type. */ category?: Category; /** Why the member is reported. */ description?: string | null; } enum Category { /** Unknown category. This value is unused */ UNKNOWN = "UNKNOWN", /** The member is reported for spam. */ SPAM = "SPAM", /** The member is reported for impersonation. */ IMPERSONATION = "IMPERSONATION", /** The member is reported for harassment. */ HARASSMENT = "HARASSMENT", /** The member is reported for other reasons. */ OTHER = "OTHER" } interface ReportMemberRequest { /** Details of a member to report. */ memberReport: MemberReport; } interface ReportMemberResponse { /** Member report. */ memberReport?: MemberReport; } interface ReportedMemberCreated { reportedMember?: ReportedMember; } /** Reported member details. */ interface ReportedMember { /** ID of the reported member. */ reportedMemberId?: string; /** Number of reports for this member. */ reportCount?: string; /** Whether reports of this member have been reviewed. */ reviewed?: boolean; /** * Date and time when the most recent report was created. * @readonly */ lastReportDate?: Date | null; } interface ReportedMemberUpdated { reportedMember?: ReportedMember; } interface SelfReportingForbiddenError { /** ID of the member that is reported. */ memberId?: string; } interface CannotReportBlockedMemberError { /** ID of the member that is reported. */ memberId?: string; } interface QueryMemberReportsRequest { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ query?: QueryV2; } interface QueryV2 { /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` * * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sorting?: Sorting[]; /** Paging options to limit and skip the number of items. */ paging?: CursorPaging$1; } interface Sorting { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder; /** * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. * * If multiple filters are provided, they are combined with AND operator. * * Example: * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } * @internal */ selectItemsBy?: Record[] | null; } enum SortOrder { ASC = "ASC", DESC = "DESC" } interface CursorPaging$1 { /** * The number of items to load. * Default: `100` */ limit?: number | null; /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursor?: string | null; } interface QueryMemberReportsResponse { /** Retrieved member reports. */ memberReports?: MemberReport[]; /** Metadata for the paginated results. */ pagingMetadata?: PagingMetadataV2$1; } interface PagingMetadataV2$1 { /** 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. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors$1; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface Cursors$1 { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface MarkMemberReportsAsReviewedRequest { /** ID of the member whose reports are to be marked as reviewed. */ memberId: string; } interface MarkMemberReportsAsReviewedResponse { /** Reported member details. */ reportedMember?: ReportedMember; } interface ListReportedMembersRequest extends ListReportedMembersRequestPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$1; /** * Paging options to limit and skip the number of items. If empty, `cursor_paging` is used. * @internal */ paging?: Paging; } /** @oneof */ interface ListReportedMembersRequestPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$1; /** * Paging options to limit and skip the number of items. If empty, `cursor_paging` is used. * @internal */ paging?: Paging; } interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface ListReportedMembersResponse { /** Retrieved reported members. */ reportedMembers?: ReportedMember[]; /** Metadata for the paginated results. */ pagingMetadata?: PagingMetadataV2$1; } interface QueryReportedMembersRequest { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ query?: QueryV2; } interface QueryReportedMembersResponse { /** Retrieved reported members. */ reportedMembers?: ReportedMember[]; /** Metadata for the paginated results. */ pagingMetadata?: PagingMetadataV2$1; } interface DeleteMemberReportsRequest { /** ID of the member whose reports to be deleted. */ memberId: string; } interface DeleteMemberReportsResponse { } interface ReportedMemberDeleted { reportedMemberId?: string; } interface DomainEvent$1 extends DomainEventBodyOneOf$1 { createdEvent?: EntityCreatedEvent$1; updatedEvent?: EntityUpdatedEvent$1; deletedEvent?: EntityDeletedEvent$1; actionEvent?: ActionEvent$1; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * 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 defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf$1 { createdEvent?: EntityCreatedEvent$1; updatedEvent?: EntityUpdatedEvent$1; deletedEvent?: EntityDeletedEvent$1; actionEvent?: ActionEvent$1; } interface EntityCreatedEvent$1 { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent$1 { /** * 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; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * WIP - This property will hold both names and values of the updated fields of the entity. * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363) * @internal */ modifiedFields?: Record; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent$1 { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted */ deletedEntityAsJson?: string | null; /** * WIP * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent$1 { bodyAsJson?: string; } interface Empty$2 { } interface MessageEnvelope$1 { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData$1; /** Stringify payload. */ data?: string; } interface IdentificationData$1 extends IdentificationDataIdOneOf$1 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType$1; } /** @oneof */ interface IdentificationDataIdOneOf$1 { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } enum WebhookIdentityType$1 { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** * Creates a report for the reported member. * @param memberReport - Details of a member to report. * @public * @documentationMaturity preview * @requiredField memberReport * @requiredField memberReport.reason * @requiredField memberReport.reportedMemberId * @permissionId MEMBERS.REPORTS_WRITE */ function reportMember(memberReport: MemberReport): Promise; /** * Retrieves a list of member reports, given the provided paging, filtering, and sorting. * * Query Member Reports runs with these defaults, which you can override: * - `createdDate` is sorted in `ASC` order * - `paging.limit` is `100` * - `paging.offset` is `0` * * For field support for filters and sorting, see [Supported Filters and Sorting](). * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). * @public * @documentationMaturity preview * @permissionId MEMBERS.REPORTS_READ * @adminMethod */ function queryMemberReports(options?: QueryMemberReportsOptions): Promise; interface QueryMemberReportsOptions { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ query?: QueryV2; } /** * Marks all reports of a member as reviewed. * @param memberId - ID of the member whose reports are to be marked as reviewed. * @public * @documentationMaturity preview * @requiredField memberId * @permissionId MEMBERS.REPORTS_UPDATE * @adminMethod */ function markMemberReportsAsReviewed(memberId: string): Promise; /** * Retrieves a list of reported members. * @public * @documentationMaturity preview * @permissionId MEMBERS.REPORTS_READ * @adminMethod * @deprecated * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews * @targetRemovalDate 2025-01-31 */ function listReportedMembers(options?: ListReportedMembersOptions): Promise; interface ListReportedMembersOptions extends ListReportedMembersRequestPagingMethodOneOf { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging$1; /** * Paging options to limit and skip the number of items. If empty, `cursor_paging` is used. * @internal */ paging?: Paging; } /** * Retrieves a list of reported members, given the provided paging, filtering, and sorting. * * Query Reported Members runs with these defaults, which you can override: * - `createdDate` is sorted in `ASC` order * - `paging.limit` is `100` * - `paging.offset` is `0` * * For field support for filters and sorting, see [Supported Filters and Sorting](). * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection). * @public * @documentationMaturity preview * @permissionId MEMBERS.REPORTS_READ * @adminMethod * @deprecated * @replacedBy wix.members.reports.v1.MemberReportOverviews.QueryMemberReportOverviews * @targetRemovalDate 2025-01-31 */ function queryReportedMembers(options?: QueryReportedMembersOptions): Promise; interface QueryReportedMembersOptions { /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */ query?: QueryV2; } /** * Deletes all reports of a member. * @param memberId - ID of the member whose reports to be deleted. * @public * @documentationMaturity preview * @requiredField memberId * @permissionId MEMBERS.REPORTS_DELETE * @adminMethod */ function deleteMemberReports(memberId: string): Promise; type membersV1MemberReport_universal_d_MemberReport = MemberReport; type membersV1MemberReport_universal_d_Reason = Reason; type membersV1MemberReport_universal_d_Category = Category; const membersV1MemberReport_universal_d_Category: typeof Category; type membersV1MemberReport_universal_d_ReportMemberRequest = ReportMemberRequest; type membersV1MemberReport_universal_d_ReportMemberResponse = ReportMemberResponse; type membersV1MemberReport_universal_d_ReportedMemberCreated = ReportedMemberCreated; type membersV1MemberReport_universal_d_ReportedMember = ReportedMember; type membersV1MemberReport_universal_d_ReportedMemberUpdated = ReportedMemberUpdated; type membersV1MemberReport_universal_d_SelfReportingForbiddenError = SelfReportingForbiddenError; type membersV1MemberReport_universal_d_CannotReportBlockedMemberError = CannotReportBlockedMemberError; type membersV1MemberReport_universal_d_QueryMemberReportsRequest = QueryMemberReportsRequest; type membersV1MemberReport_universal_d_QueryV2 = QueryV2; type membersV1MemberReport_universal_d_Sorting = Sorting; type membersV1MemberReport_universal_d_SortOrder = SortOrder; const membersV1MemberReport_universal_d_SortOrder: typeof SortOrder; type membersV1MemberReport_universal_d_QueryMemberReportsResponse = QueryMemberReportsResponse; type membersV1MemberReport_universal_d_MarkMemberReportsAsReviewedRequest = MarkMemberReportsAsReviewedRequest; type membersV1MemberReport_universal_d_MarkMemberReportsAsReviewedResponse = MarkMemberReportsAsReviewedResponse; type membersV1MemberReport_universal_d_ListReportedMembersRequest = ListReportedMembersRequest; type membersV1MemberReport_universal_d_ListReportedMembersRequestPagingMethodOneOf = ListReportedMembersRequestPagingMethodOneOf; type membersV1MemberReport_universal_d_Paging = Paging; type membersV1MemberReport_universal_d_ListReportedMembersResponse = ListReportedMembersResponse; type membersV1MemberReport_universal_d_QueryReportedMembersRequest = QueryReportedMembersRequest; type membersV1MemberReport_universal_d_QueryReportedMembersResponse = QueryReportedMembersResponse; type membersV1MemberReport_universal_d_DeleteMemberReportsRequest = DeleteMemberReportsRequest; type membersV1MemberReport_universal_d_DeleteMemberReportsResponse = DeleteMemberReportsResponse; type membersV1MemberReport_universal_d_ReportedMemberDeleted = ReportedMemberDeleted; type membersV1MemberReport_universal_d_RestoreInfo = RestoreInfo; const membersV1MemberReport_universal_d_reportMember: typeof reportMember; const membersV1MemberReport_universal_d_queryMemberReports: typeof queryMemberReports; type membersV1MemberReport_universal_d_QueryMemberReportsOptions = QueryMemberReportsOptions; const membersV1MemberReport_universal_d_markMemberReportsAsReviewed: typeof markMemberReportsAsReviewed; const membersV1MemberReport_universal_d_listReportedMembers: typeof listReportedMembers; type membersV1MemberReport_universal_d_ListReportedMembersOptions = ListReportedMembersOptions; const membersV1MemberReport_universal_d_queryReportedMembers: typeof queryReportedMembers; type membersV1MemberReport_universal_d_QueryReportedMembersOptions = QueryReportedMembersOptions; const membersV1MemberReport_universal_d_deleteMemberReports: typeof deleteMemberReports; namespace membersV1MemberReport_universal_d { export { membersV1MemberReport_universal_d_MemberReport as MemberReport, membersV1MemberReport_universal_d_Reason as Reason, membersV1MemberReport_universal_d_Category as Category, membersV1MemberReport_universal_d_ReportMemberRequest as ReportMemberRequest, membersV1MemberReport_universal_d_ReportMemberResponse as ReportMemberResponse, membersV1MemberReport_universal_d_ReportedMemberCreated as ReportedMemberCreated, membersV1MemberReport_universal_d_ReportedMember as ReportedMember, membersV1MemberReport_universal_d_ReportedMemberUpdated as ReportedMemberUpdated, membersV1MemberReport_universal_d_SelfReportingForbiddenError as SelfReportingForbiddenError, membersV1MemberReport_universal_d_CannotReportBlockedMemberError as CannotReportBlockedMemberError, membersV1MemberReport_universal_d_QueryMemberReportsRequest as QueryMemberReportsRequest, membersV1MemberReport_universal_d_QueryV2 as QueryV2, membersV1MemberReport_universal_d_Sorting as Sorting, membersV1MemberReport_universal_d_SortOrder as SortOrder, CursorPaging$1 as CursorPaging, membersV1MemberReport_universal_d_QueryMemberReportsResponse as QueryMemberReportsResponse, PagingMetadataV2$1 as PagingMetadataV2, Cursors$1 as Cursors, membersV1MemberReport_universal_d_MarkMemberReportsAsReviewedRequest as MarkMemberReportsAsReviewedRequest, membersV1MemberReport_universal_d_MarkMemberReportsAsReviewedResponse as MarkMemberReportsAsReviewedResponse, membersV1MemberReport_universal_d_ListReportedMembersRequest as ListReportedMembersRequest, membersV1MemberReport_universal_d_ListReportedMembersRequestPagingMethodOneOf as ListReportedMembersRequestPagingMethodOneOf, membersV1MemberReport_universal_d_Paging as Paging, membersV1MemberReport_universal_d_ListReportedMembersResponse as ListReportedMembersResponse, membersV1MemberReport_universal_d_QueryReportedMembersRequest as QueryReportedMembersRequest, membersV1MemberReport_universal_d_QueryReportedMembersResponse as QueryReportedMembersResponse, membersV1MemberReport_universal_d_DeleteMemberReportsRequest as DeleteMemberReportsRequest, membersV1MemberReport_universal_d_DeleteMemberReportsResponse as DeleteMemberReportsResponse, membersV1MemberReport_universal_d_ReportedMemberDeleted as ReportedMemberDeleted, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, EntityCreatedEvent$1 as EntityCreatedEvent, membersV1MemberReport_universal_d_RestoreInfo as RestoreInfo, EntityUpdatedEvent$1 as EntityUpdatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, ActionEvent$1 as ActionEvent, Empty$2 as Empty, MessageEnvelope$1 as MessageEnvelope, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, WebhookIdentityType$1 as WebhookIdentityType, membersV1MemberReport_universal_d_reportMember as reportMember, membersV1MemberReport_universal_d_queryMemberReports as queryMemberReports, membersV1MemberReport_universal_d_QueryMemberReportsOptions as QueryMemberReportsOptions, membersV1MemberReport_universal_d_markMemberReportsAsReviewed as markMemberReportsAsReviewed, membersV1MemberReport_universal_d_listReportedMembers as listReportedMembers, membersV1MemberReport_universal_d_ListReportedMembersOptions as ListReportedMembersOptions, membersV1MemberReport_universal_d_queryReportedMembers as queryReportedMembers, membersV1MemberReport_universal_d_QueryReportedMembersOptions as QueryReportedMembersOptions, membersV1MemberReport_universal_d_deleteMemberReports as deleteMemberReports, }; } interface MemberRoleDefinition { /** @readonly */ _id?: string; roleKey?: string; title?: string; blockable?: boolean; /** Revision number, used for checking the optimistic lock condition. */ revision?: string | null; } interface SyncMetaSiteRolesRequest { siteMembersInstanceId?: string | null; metaSiteId?: string | null; } interface SyncMetaSiteRolesResponse { } interface CreateMemberRoleDefinitionRequest { roleKey: string; roleTitle: string; blockable?: boolean; } interface CreateMemberRoleDefinitionResponse { role?: MemberRoleDefinition; } interface ListMemberRoleDefinitionsRequest { } interface ListMemberRoleDefinitionsResponse { roles?: MemberRoleDefinition[]; } interface GetMemberRoleDefinitionRequest { roleKey: string; } interface GetMemberRoleDefinitionResponse { role?: MemberRoleDefinition; } interface UpdateMemberRoleDefinitionRequest { key: string; blockable?: boolean; revision: string | null; } interface UpdateMemberRoleDefinitionResponse { role?: MemberRoleDefinition; } interface DeleteMemberRoleDefinitionRequest { roleKey: string; } interface DeleteMemberRoleDefinitionResponse { } 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; /** A meta site id. */ 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 */ 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; } interface Asset { /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */ appDefId?: string; /** An instance id. For legacy reasons may be UUID or a string. */ instanceId?: string; /** An application state. */ state?: State; } enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } interface SiteCreated { /** A template identifier (empty if not created from a template). */ originTemplateId?: string; /** An account id of the owner. */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContext; /** * 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. */ originMetaSiteId?: string | null; /** A meta site name (URL slug). */ siteName?: string; /** A namespace. */ namespace?: Namespace; } 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" } 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" } /** Site transferred to another user. */ interface SiteTransferred { /** A previous owner id (user that transfers meta site). */ oldOwnerId?: string; /** A new owner id (user that accepts meta site). */ 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?: DeleteStatus; /** A reason (flow). */ deleteOrigin?: string; /** A service that deleted it. */ initiatorId?: string | null; } enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE" } /** 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. */ 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. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** An instance id from which this instance is originated. */ originInstanceId?: string; /** A version. */ version?: string | null; /** The origin meta site id */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** Either UUID or EmbeddedServiceType. */ appDefId?: string; /** Not only UUID. Something here could be something weird. */ instanceId?: string; /** A version. */ 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). */ newSiteName?: string; /** A previous meta site name (URL slug). */ 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?: Namespace; /** A new namespace. */ newNamespace?: Namespace; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } interface Empty$1 { } /** @internal * @documentationMaturity preview * @adminMethod */ function syncMetaSiteRoles(options?: SyncMetaSiteRolesOptions): Promise; interface SyncMetaSiteRolesOptions { siteMembersInstanceId?: string | null; metaSiteId?: string | null; } /** @public * @documentationMaturity preview * @requiredField options.roleTitle * @requiredField roleKey * @permissionId MEMBERS.ROLES_MANAGE * @adminMethod */ function createMemberRoleDefinition(roleKey: string, options?: CreateMemberRoleDefinitionOptions): Promise; interface CreateMemberRoleDefinitionOptions { roleTitle: string; blockable?: boolean; } /** @public * @documentationMaturity preview * @permissionId MEMBERS.ROLES_MANAGE * @adminMethod */ function listMemberRoleDefinitions(): Promise; /** @public * @documentationMaturity preview * @requiredField roleKey * @permissionId MEMBERS.ROLES_MANAGE * @adminMethod */ function getMemberRoleDefinition(roleKey: string): Promise; /** @public * @documentationMaturity preview * @requiredField key * @requiredField options.revision * @permissionId MEMBERS.ROLES_MANAGE * @adminMethod */ function updateMemberRoleDefinition(key: string, options?: UpdateMemberRoleDefinitionOptions): Promise; interface UpdateMemberRoleDefinitionOptions { blockable?: boolean; revision: string | null; } /** @public * @documentationMaturity preview * @requiredField roleKey * @permissionId MEMBERS.ROLES_MANAGE * @adminMethod */ function deleteMemberRoleDefinition(roleKey: string): Promise; type membersV1MemberRoleDefinition_universal_d_MemberRoleDefinition = MemberRoleDefinition; type membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesRequest = SyncMetaSiteRolesRequest; type membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesResponse = SyncMetaSiteRolesResponse; type membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionRequest = CreateMemberRoleDefinitionRequest; type membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionResponse = CreateMemberRoleDefinitionResponse; type membersV1MemberRoleDefinition_universal_d_ListMemberRoleDefinitionsRequest = ListMemberRoleDefinitionsRequest; type membersV1MemberRoleDefinition_universal_d_ListMemberRoleDefinitionsResponse = ListMemberRoleDefinitionsResponse; type membersV1MemberRoleDefinition_universal_d_GetMemberRoleDefinitionRequest = GetMemberRoleDefinitionRequest; type membersV1MemberRoleDefinition_universal_d_GetMemberRoleDefinitionResponse = GetMemberRoleDefinitionResponse; type membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionRequest = UpdateMemberRoleDefinitionRequest; type membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionResponse = UpdateMemberRoleDefinitionResponse; type membersV1MemberRoleDefinition_universal_d_DeleteMemberRoleDefinitionRequest = DeleteMemberRoleDefinitionRequest; type membersV1MemberRoleDefinition_universal_d_DeleteMemberRoleDefinitionResponse = DeleteMemberRoleDefinitionResponse; type membersV1MemberRoleDefinition_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent; type membersV1MemberRoleDefinition_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf; type membersV1MemberRoleDefinition_universal_d_Asset = Asset; type membersV1MemberRoleDefinition_universal_d_State = State; const membersV1MemberRoleDefinition_universal_d_State: typeof State; type membersV1MemberRoleDefinition_universal_d_SiteCreated = SiteCreated; type membersV1MemberRoleDefinition_universal_d_SiteCreatedContext = SiteCreatedContext; const membersV1MemberRoleDefinition_universal_d_SiteCreatedContext: typeof SiteCreatedContext; type membersV1MemberRoleDefinition_universal_d_Namespace = Namespace; const membersV1MemberRoleDefinition_universal_d_Namespace: typeof Namespace; type membersV1MemberRoleDefinition_universal_d_SiteTransferred = SiteTransferred; type membersV1MemberRoleDefinition_universal_d_SiteDeleted = SiteDeleted; type membersV1MemberRoleDefinition_universal_d_DeleteContext = DeleteContext; type membersV1MemberRoleDefinition_universal_d_DeleteStatus = DeleteStatus; const membersV1MemberRoleDefinition_universal_d_DeleteStatus: typeof DeleteStatus; type membersV1MemberRoleDefinition_universal_d_SiteUndeleted = SiteUndeleted; type membersV1MemberRoleDefinition_universal_d_SitePublished = SitePublished; type membersV1MemberRoleDefinition_universal_d_SiteUnpublished = SiteUnpublished; type membersV1MemberRoleDefinition_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate; type membersV1MemberRoleDefinition_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite; type membersV1MemberRoleDefinition_universal_d_ServiceProvisioned = ServiceProvisioned; type membersV1MemberRoleDefinition_universal_d_ServiceRemoved = ServiceRemoved; type membersV1MemberRoleDefinition_universal_d_SiteRenamed = SiteRenamed; type membersV1MemberRoleDefinition_universal_d_SiteHardDeleted = SiteHardDeleted; type membersV1MemberRoleDefinition_universal_d_NamespaceChanged = NamespaceChanged; type membersV1MemberRoleDefinition_universal_d_StudioAssigned = StudioAssigned; type membersV1MemberRoleDefinition_universal_d_StudioUnassigned = StudioUnassigned; const membersV1MemberRoleDefinition_universal_d_syncMetaSiteRoles: typeof syncMetaSiteRoles; type membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesOptions = SyncMetaSiteRolesOptions; const membersV1MemberRoleDefinition_universal_d_createMemberRoleDefinition: typeof createMemberRoleDefinition; type membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionOptions = CreateMemberRoleDefinitionOptions; const membersV1MemberRoleDefinition_universal_d_listMemberRoleDefinitions: typeof listMemberRoleDefinitions; const membersV1MemberRoleDefinition_universal_d_getMemberRoleDefinition: typeof getMemberRoleDefinition; const membersV1MemberRoleDefinition_universal_d_updateMemberRoleDefinition: typeof updateMemberRoleDefinition; type membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionOptions = UpdateMemberRoleDefinitionOptions; const membersV1MemberRoleDefinition_universal_d_deleteMemberRoleDefinition: typeof deleteMemberRoleDefinition; namespace membersV1MemberRoleDefinition_universal_d { export { membersV1MemberRoleDefinition_universal_d_MemberRoleDefinition as MemberRoleDefinition, membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesRequest as SyncMetaSiteRolesRequest, membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesResponse as SyncMetaSiteRolesResponse, membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionRequest as CreateMemberRoleDefinitionRequest, membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionResponse as CreateMemberRoleDefinitionResponse, membersV1MemberRoleDefinition_universal_d_ListMemberRoleDefinitionsRequest as ListMemberRoleDefinitionsRequest, membersV1MemberRoleDefinition_universal_d_ListMemberRoleDefinitionsResponse as ListMemberRoleDefinitionsResponse, membersV1MemberRoleDefinition_universal_d_GetMemberRoleDefinitionRequest as GetMemberRoleDefinitionRequest, membersV1MemberRoleDefinition_universal_d_GetMemberRoleDefinitionResponse as GetMemberRoleDefinitionResponse, membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionRequest as UpdateMemberRoleDefinitionRequest, membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionResponse as UpdateMemberRoleDefinitionResponse, membersV1MemberRoleDefinition_universal_d_DeleteMemberRoleDefinitionRequest as DeleteMemberRoleDefinitionRequest, membersV1MemberRoleDefinition_universal_d_DeleteMemberRoleDefinitionResponse as DeleteMemberRoleDefinitionResponse, membersV1MemberRoleDefinition_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, membersV1MemberRoleDefinition_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, membersV1MemberRoleDefinition_universal_d_Asset as Asset, membersV1MemberRoleDefinition_universal_d_State as State, membersV1MemberRoleDefinition_universal_d_SiteCreated as SiteCreated, membersV1MemberRoleDefinition_universal_d_SiteCreatedContext as SiteCreatedContext, membersV1MemberRoleDefinition_universal_d_Namespace as Namespace, membersV1MemberRoleDefinition_universal_d_SiteTransferred as SiteTransferred, membersV1MemberRoleDefinition_universal_d_SiteDeleted as SiteDeleted, membersV1MemberRoleDefinition_universal_d_DeleteContext as DeleteContext, membersV1MemberRoleDefinition_universal_d_DeleteStatus as DeleteStatus, membersV1MemberRoleDefinition_universal_d_SiteUndeleted as SiteUndeleted, membersV1MemberRoleDefinition_universal_d_SitePublished as SitePublished, membersV1MemberRoleDefinition_universal_d_SiteUnpublished as SiteUnpublished, membersV1MemberRoleDefinition_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, membersV1MemberRoleDefinition_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, membersV1MemberRoleDefinition_universal_d_ServiceProvisioned as ServiceProvisioned, membersV1MemberRoleDefinition_universal_d_ServiceRemoved as ServiceRemoved, membersV1MemberRoleDefinition_universal_d_SiteRenamed as SiteRenamed, membersV1MemberRoleDefinition_universal_d_SiteHardDeleted as SiteHardDeleted, membersV1MemberRoleDefinition_universal_d_NamespaceChanged as NamespaceChanged, membersV1MemberRoleDefinition_universal_d_StudioAssigned as StudioAssigned, membersV1MemberRoleDefinition_universal_d_StudioUnassigned as StudioUnassigned, Empty$1 as Empty, membersV1MemberRoleDefinition_universal_d_syncMetaSiteRoles as syncMetaSiteRoles, membersV1MemberRoleDefinition_universal_d_SyncMetaSiteRolesOptions as SyncMetaSiteRolesOptions, membersV1MemberRoleDefinition_universal_d_createMemberRoleDefinition as createMemberRoleDefinition, membersV1MemberRoleDefinition_universal_d_CreateMemberRoleDefinitionOptions as CreateMemberRoleDefinitionOptions, membersV1MemberRoleDefinition_universal_d_listMemberRoleDefinitions as listMemberRoleDefinitions, membersV1MemberRoleDefinition_universal_d_getMemberRoleDefinition as getMemberRoleDefinition, membersV1MemberRoleDefinition_universal_d_updateMemberRoleDefinition as updateMemberRoleDefinition, membersV1MemberRoleDefinition_universal_d_UpdateMemberRoleDefinitionOptions as UpdateMemberRoleDefinitionOptions, membersV1MemberRoleDefinition_universal_d_deleteMemberRoleDefinition as deleteMemberRoleDefinition, }; } /** Member-to-member block. */ interface MemberToMemberBlock { /** ID of the member that is the creator of this block. */ blockingMemberId?: string; /** ID of the member that is blocked by this block. */ blockedMemberId?: string; } interface BlockMemberRequest { /** ID of a member to block. */ memberId: string; } interface BlockMemberResponse { } interface MemberBlockedByMember { /** The block that has been created. */ block?: MemberToMemberBlock; } interface MemberAlreadyBlockedError { initiatorMemberId?: string; targetMemberId?: string; } interface SelfBlockingForbiddenError { initiatorMemberId?: string; } interface AdminBlockingForbiddenError { initiatorMemberId?: string; targetMemberId?: string; adminMemberId?: string; } interface UnblockMemberRequest { /** ID of a member to unblock. */ memberId: string; } interface UnblockMemberResponse { } interface MemberUnblockedByMember { /** The block that has been removed. */ block?: MemberToMemberBlock; } interface SelfUnblockingForbiddenError { initiatorMemberId?: string; } interface BlockDoesNotExistError { blockingMemberId?: string; blockedMemberId?: string; } interface ListCurrentMemberBlockingRequest { /** Pagination parameters. */ cursorPaging?: CursorPaging; } interface CursorPaging { /** Maximum number of items to return in the results. */ 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. */ cursor?: string | null; } interface ListCurrentMemberBlockingResponse { /** IDs of members blocked by the current member. */ blockedMemberIds?: string[]; /** Metadata for the paginated results. */ pagingMetadata?: PagingMetadataV2; } interface PagingMetadataV2 { /** 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. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface Cursors { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface ListMemberBlocksRequest { /** ID of a member whose blocks are requested. */ memberId: string; /** Pagination parameters. */ cursorPaging?: CursorPaging; } interface ListMemberBlocksResponse { /** List of members who are either blocking or blocked by the specified member. */ memberBlocks?: MemberBlock[]; /** Metadata for the paginated results. */ pagingMetadata?: PagingMetadataV2; } interface MemberBlock { /** Member ID. */ memberId?: string; /** * Indicates whether the member with `memberId` is blocking or blocked by the specified member. * * - `BLOCKING`: The member with `memberId` is blocking the requested member. * - `BLOCKED`: The member with `memberId` is blocked by the requested member. */ blockDirection?: BlockDirection; } enum BlockDirection { UNKNOWN = "UNKNOWN", BLOCKING = "BLOCKING", BLOCKED = "BLOCKED" } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ _id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * Example: created/updated/deleted/started/completed/email_opened */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp. */ 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 defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ 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 * @internal */ triggeredByUndelete?: boolean | null; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ undeleteInfo?: UndeleteInfo; } interface UndeleteInfo { 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; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * WIP - This property will hold both names and values of the updated fields of the entity. * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363) * @internal */ modifiedFields?: Record; } interface EntityDeletedEvent { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface Empty { } interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType; } /** @oneof */ interface IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** * Blocks the specified member from the current member. * @param memberId - ID of a member to block. * @public * @documentationMaturity preview * @requiredField memberId * @permissionId MEMBERS.MEMBER_TO_MEMBER_BLOCKS_WRITE */ function blockMember(memberId: string): Promise; /** * Unblocks the specified member from the current member. * @param memberId - ID of a member to unblock. * @public * @documentationMaturity preview * @requiredField memberId * @permissionId MEMBERS.MEMBER_TO_MEMBER_BLOCKS_WRITE */ function unblockMember(memberId: string): Promise; /** * Returns information about members blocked by the current member. * @public * @documentationMaturity preview * @permissionId MEMBERS.MEMBER_TO_MEMBER_BLOCKS_READ */ function listCurrentMemberBlocking(options?: ListCurrentMemberBlockingOptions): Promise; interface ListCurrentMemberBlockingOptions { /** Pagination parameters. */ cursorPaging?: CursorPaging; } /** * Returns IDs of members that are blocking or blocked by the member whose ID was provided. * @param memberId - ID of a member whose blocks are requested. * @public * @documentationMaturity preview * @requiredField memberId * @permissionId MEMBERS.MEMBER_TO_MEMBER_BLOCKS_READ_MEMBER_BLOCKS * @adminMethod */ function listMemberBlocks(memberId: string, options?: ListMemberBlocksOptions): Promise; interface ListMemberBlocksOptions { /** Pagination parameters. */ cursorPaging?: CursorPaging; } type membersV1MemberToMemberBlock_universal_d_MemberToMemberBlock = MemberToMemberBlock; type membersV1MemberToMemberBlock_universal_d_BlockMemberRequest = BlockMemberRequest; type membersV1MemberToMemberBlock_universal_d_BlockMemberResponse = BlockMemberResponse; type membersV1MemberToMemberBlock_universal_d_MemberBlockedByMember = MemberBlockedByMember; type membersV1MemberToMemberBlock_universal_d_MemberAlreadyBlockedError = MemberAlreadyBlockedError; type membersV1MemberToMemberBlock_universal_d_SelfBlockingForbiddenError = SelfBlockingForbiddenError; type membersV1MemberToMemberBlock_universal_d_AdminBlockingForbiddenError = AdminBlockingForbiddenError; type membersV1MemberToMemberBlock_universal_d_UnblockMemberRequest = UnblockMemberRequest; type membersV1MemberToMemberBlock_universal_d_UnblockMemberResponse = UnblockMemberResponse; type membersV1MemberToMemberBlock_universal_d_MemberUnblockedByMember = MemberUnblockedByMember; type membersV1MemberToMemberBlock_universal_d_SelfUnblockingForbiddenError = SelfUnblockingForbiddenError; type membersV1MemberToMemberBlock_universal_d_BlockDoesNotExistError = BlockDoesNotExistError; type membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingRequest = ListCurrentMemberBlockingRequest; type membersV1MemberToMemberBlock_universal_d_CursorPaging = CursorPaging; type membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingResponse = ListCurrentMemberBlockingResponse; type membersV1MemberToMemberBlock_universal_d_PagingMetadataV2 = PagingMetadataV2; type membersV1MemberToMemberBlock_universal_d_Cursors = Cursors; type membersV1MemberToMemberBlock_universal_d_ListMemberBlocksRequest = ListMemberBlocksRequest; type membersV1MemberToMemberBlock_universal_d_ListMemberBlocksResponse = ListMemberBlocksResponse; type membersV1MemberToMemberBlock_universal_d_MemberBlock = MemberBlock; type membersV1MemberToMemberBlock_universal_d_BlockDirection = BlockDirection; const membersV1MemberToMemberBlock_universal_d_BlockDirection: typeof BlockDirection; type membersV1MemberToMemberBlock_universal_d_DomainEvent = DomainEvent; type membersV1MemberToMemberBlock_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf; type membersV1MemberToMemberBlock_universal_d_EntityCreatedEvent = EntityCreatedEvent; type membersV1MemberToMemberBlock_universal_d_UndeleteInfo = UndeleteInfo; type membersV1MemberToMemberBlock_universal_d_EntityUpdatedEvent = EntityUpdatedEvent; type membersV1MemberToMemberBlock_universal_d_EntityDeletedEvent = EntityDeletedEvent; type membersV1MemberToMemberBlock_universal_d_ActionEvent = ActionEvent; type membersV1MemberToMemberBlock_universal_d_Empty = Empty; type membersV1MemberToMemberBlock_universal_d_MessageEnvelope = MessageEnvelope; type membersV1MemberToMemberBlock_universal_d_IdentificationData = IdentificationData; type membersV1MemberToMemberBlock_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf; type membersV1MemberToMemberBlock_universal_d_WebhookIdentityType = WebhookIdentityType; const membersV1MemberToMemberBlock_universal_d_WebhookIdentityType: typeof WebhookIdentityType; const membersV1MemberToMemberBlock_universal_d_blockMember: typeof blockMember; const membersV1MemberToMemberBlock_universal_d_unblockMember: typeof unblockMember; const membersV1MemberToMemberBlock_universal_d_listCurrentMemberBlocking: typeof listCurrentMemberBlocking; type membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingOptions = ListCurrentMemberBlockingOptions; const membersV1MemberToMemberBlock_universal_d_listMemberBlocks: typeof listMemberBlocks; type membersV1MemberToMemberBlock_universal_d_ListMemberBlocksOptions = ListMemberBlocksOptions; namespace membersV1MemberToMemberBlock_universal_d { export { membersV1MemberToMemberBlock_universal_d_MemberToMemberBlock as MemberToMemberBlock, membersV1MemberToMemberBlock_universal_d_BlockMemberRequest as BlockMemberRequest, membersV1MemberToMemberBlock_universal_d_BlockMemberResponse as BlockMemberResponse, membersV1MemberToMemberBlock_universal_d_MemberBlockedByMember as MemberBlockedByMember, membersV1MemberToMemberBlock_universal_d_MemberAlreadyBlockedError as MemberAlreadyBlockedError, membersV1MemberToMemberBlock_universal_d_SelfBlockingForbiddenError as SelfBlockingForbiddenError, membersV1MemberToMemberBlock_universal_d_AdminBlockingForbiddenError as AdminBlockingForbiddenError, membersV1MemberToMemberBlock_universal_d_UnblockMemberRequest as UnblockMemberRequest, membersV1MemberToMemberBlock_universal_d_UnblockMemberResponse as UnblockMemberResponse, membersV1MemberToMemberBlock_universal_d_MemberUnblockedByMember as MemberUnblockedByMember, membersV1MemberToMemberBlock_universal_d_SelfUnblockingForbiddenError as SelfUnblockingForbiddenError, membersV1MemberToMemberBlock_universal_d_BlockDoesNotExistError as BlockDoesNotExistError, membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingRequest as ListCurrentMemberBlockingRequest, membersV1MemberToMemberBlock_universal_d_CursorPaging as CursorPaging, membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingResponse as ListCurrentMemberBlockingResponse, membersV1MemberToMemberBlock_universal_d_PagingMetadataV2 as PagingMetadataV2, membersV1MemberToMemberBlock_universal_d_Cursors as Cursors, membersV1MemberToMemberBlock_universal_d_ListMemberBlocksRequest as ListMemberBlocksRequest, membersV1MemberToMemberBlock_universal_d_ListMemberBlocksResponse as ListMemberBlocksResponse, membersV1MemberToMemberBlock_universal_d_MemberBlock as MemberBlock, membersV1MemberToMemberBlock_universal_d_BlockDirection as BlockDirection, membersV1MemberToMemberBlock_universal_d_DomainEvent as DomainEvent, membersV1MemberToMemberBlock_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf, membersV1MemberToMemberBlock_universal_d_EntityCreatedEvent as EntityCreatedEvent, membersV1MemberToMemberBlock_universal_d_UndeleteInfo as UndeleteInfo, membersV1MemberToMemberBlock_universal_d_EntityUpdatedEvent as EntityUpdatedEvent, membersV1MemberToMemberBlock_universal_d_EntityDeletedEvent as EntityDeletedEvent, membersV1MemberToMemberBlock_universal_d_ActionEvent as ActionEvent, membersV1MemberToMemberBlock_universal_d_Empty as Empty, membersV1MemberToMemberBlock_universal_d_MessageEnvelope as MessageEnvelope, membersV1MemberToMemberBlock_universal_d_IdentificationData as IdentificationData, membersV1MemberToMemberBlock_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, membersV1MemberToMemberBlock_universal_d_WebhookIdentityType as WebhookIdentityType, membersV1MemberToMemberBlock_universal_d_blockMember as blockMember, membersV1MemberToMemberBlock_universal_d_unblockMember as unblockMember, membersV1MemberToMemberBlock_universal_d_listCurrentMemberBlocking as listCurrentMemberBlocking, membersV1MemberToMemberBlock_universal_d_ListCurrentMemberBlockingOptions as ListCurrentMemberBlockingOptions, membersV1MemberToMemberBlock_universal_d_listMemberBlocks as listMemberBlocks, membersV1MemberToMemberBlock_universal_d_ListMemberBlocksOptions as ListMemberBlocksOptions, }; } export { badgesV4Badge_universal_d as badgesV4, membersV1CustomField_universal_d as customField, membersV1CustomFieldSuggestion_universal_d as customFieldSuggestion, membersV1DefaultPrivacy_universal_d as defaultPrivacy, membersV1MemberReport_universal_d as memberReport, membersV1MemberRoleDefinition_universal_d as memberRoleDefinition, membersV1MemberToMemberBlock_universal_d as memberToMemberBlock, membersUsermembersV1UserMember_universal_d as userMember }; }