@wix/auto_sdk_members_members 1.0.0

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

@@ -0,0 +1,1283 @@
+export interface Member {
+    /**
+     * Member ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Email used by the member to log in to the site. */
+    loginEmail?: string | null;
+    /**
+     * Whether the email used by the member has been verified.
+     * @readonly
+     */
+    loginEmailVerified?: boolean | null;
+    /**
+     * Member site access status.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Contact ID.
+     * @readonly
+     */
+    contactId?: string | null;
+    /**
+     * Member's contact information. Contact information is stored in the
+     * [Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).
+     *
+     * The full set of contact data can be accessed and managed with the
+     * [Contacts API](https://dev.wix.com/api/rest/contacts/contacts).
+     */
+    contact?: Contact;
+    /** Profile display details. */
+    profile?: Profile;
+    /** Member privacy status. */
+    privacyStatus?: PrivacyStatusStatus;
+    /**
+     * Member activity status.
+     * @readonly
+     */
+    activityStatus?: ActivityStatusStatus;
+    /**
+     * Date and time when the member was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time when the member was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Date and time when the member last logged in to the site.
+     * @readonly
+     */
+    lastLoginDate?: Date | null;
+}
+export declare enum Status {
+    /** Insufficient permissions to get the status. */
+    UNKNOWN = "UNKNOWN",
+    /** Member created and is waiting for approval by site owner. */
+    PENDING = "PENDING",
+    /** Member can log in to the site. */
+    APPROVED = "APPROVED",
+    /** Member is blocked and can't log in to the site. */
+    BLOCKED = "BLOCKED",
+    /** Member is a [guest author](https://support.wix.com/en/article/wix-blog-adding-guest-authors-to-your-blog) for the site blog and can't log in to the site. */
+    OFFLINE = "OFFLINE"
+}
+/** Contact info associated with the member. */
+export interface Contact {
+    /**
+     * Contact ID.
+     *
+     * > **Deprecation notice:**
+     * > This property has been replaced with `member.contactId`
+     * > and will be removed on June 11, 2021.
+     * @readonly
+     * @deprecated
+     */
+    contactId?: string | null;
+    /** Contact's first name. */
+    firstName?: string | null;
+    /** Contact's last name. */
+    lastName?: string | null;
+    /** List of phone numbers. */
+    phones?: string[] | null;
+    /** List of email addresses. */
+    emails?: string[] | null;
+    /** List of street addresses. */
+    addresses?: Address[];
+    /**
+     * Contact's birthdate, formatted as `"YYYY-MM-DD"`.
+     *
+     * Example: `"2020-03-15"` for March 15, 2020.
+     */
+    birthdate?: string | null;
+    /** Contact's company name. */
+    company?: string | null;
+    /** Contact's job title. */
+    jobTitle?: string | null;
+    /**
+     * Custom fields,
+     * where each key is the field key,
+     * and each value is the field's value for the member.
+     */
+    customFields?: Record<string, CustomField>;
+}
+/** Street address. */
+export interface Address extends AddressStreetOneOf {
+    /** Street address object, with number and name in separate fields. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number, as free text. */
+    addressLine?: string | null;
+    /**
+     * Street address ID.
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Free text providing more detailed address information,
+     * such as apartment, suite, or floor.
+     */
+    addressLine2?: string | null;
+    /** City name. */
+    city?: string | null;
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in an
+     * [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
+     */
+    subdivision?: string | null;
+    /**
+     * 2-letter country code in an
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+     */
+    country?: string | null;
+    /** Postal code. */
+    postalCode?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** Street address object, with number and name in separate fields. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number, as free text. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface CustomField {
+    /** Custom field name. */
+    name?: string | null;
+    /** Custom field value. */
+    value?: any;
+}
+/** Member Profile */
+export interface Profile {
+    /**
+     * Name that identifies the member to other members.
+     * Displayed on the member's profile page
+     * and interactions in the forum or blog.
+     */
+    nickname?: string | null;
+    /**
+     * Slug that determines the member's profile page URL.
+     * @readonly
+     */
+    slug?: string | null;
+    /** Member's profile photo. */
+    photo?: Image;
+    /**
+     * Member's cover photo,
+     * used as a background picture in members profile page.
+     *
+     * Cover positioning can be altered with `cover.offsetX` and `cover.offsetY`.
+     * When left empty, the values default to `0`.
+     */
+    cover?: Image;
+    /**
+     * Member title.
+     *
+     * Currently available through the API only.
+     */
+    title?: string | null;
+}
+export 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;
+}
+export declare enum PrivacyStatusStatus {
+    /** Insufficient permissions to get the status. */
+    UNKNOWN = "UNKNOWN",
+    /** Member is hidden from site visitors and other site members. Member is returned only to site contributors and apps with the appropriate permissions. */
+    PRIVATE = "PRIVATE",
+    /** Member is visible to everyone. */
+    PUBLIC = "PUBLIC"
+}
+export declare enum ActivityStatusStatus {
+    /** Insufficient permissions to get the status. */
+    UNKNOWN = "UNKNOWN",
+    /** Member can write forum posts and blog comments. */
+    ACTIVE = "ACTIVE",
+    /** Member can't write forum posts or blog comments. */
+    MUTED = "MUTED"
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface InvalidateCache extends InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+    /** tell us why you're invalidating the cache. You don't need to add your app name */
+    reason?: string | null;
+    /** Is local DS */
+    localDc?: boolean;
+    hardPurge?: boolean;
+}
+/** @oneof */
+export interface InvalidateCacheGetByOneOf {
+    /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
+    metaSiteId?: string;
+    /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
+    siteId?: string;
+    /** Invalidate by App */
+    app?: App;
+    /** Invalidate by page id */
+    page?: Page;
+    /** Invalidate by URI path */
+    uri?: URI;
+    /** Invalidate by file (for media files such as PDFs) */
+    file?: File;
+}
+export interface App {
+    /** The AppDefId */
+    appDefId?: string;
+    /** The instance Id */
+    instanceId?: string;
+}
+export interface Page {
+    /** the msid the page is on */
+    metaSiteId?: string;
+    /** Invalidate by Page ID */
+    pageId?: string;
+}
+export interface URI {
+    /** the msid the URI is on */
+    metaSiteId?: string;
+    /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
+    uriPath?: string;
+}
+export interface File {
+    /** the msid the file is related to */
+    metaSiteId?: string;
+    /** Invalidate by filename (for media files such as PDFs) */
+    fileName?: string;
+}
+export interface UpdateMySlugRequest {
+    /** New slug. */
+    slug: string;
+}
+export interface UpdateMySlugResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface SlugAlreadyExistsPayload {
+    slug?: string;
+}
+export interface UpdateMemberSlugRequest {
+    /** Member ID. */
+    id: string;
+    /** New slug. */
+    slug: string;
+}
+export interface UpdateMemberSlugResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface JoinCommunityRequest {
+}
+/** Member profile. */
+export interface JoinCommunityResponse {
+    /** The updated member. */
+    member?: Member;
+}
+export interface MemberJoinedCommunity {
+    /**
+     * Member id who joined the community
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface LeaveCommunityRequest {
+}
+/** Member profile. */
+export interface LeaveCommunityResponse {
+    /** The updated member. */
+    member?: Member;
+}
+export interface MemberLeftCommunity {
+    /**
+     * Member id who left the community
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface GetMyMemberRequest {
+    /**
+     * Predefined set of fields to return.
+     *
+     * - `"FULL"`: Returns all fields.
+     * - `"PUBLIC"`: Returns `_id` and all fields under `profile`.
+     *
+     * > **Note:**
+     * > When returning the `"PUBLIC"` fieldset,
+     * > `profile.status`, `profile.privacyStatus`, and `profile.activityStatus`
+     * > are returned as `"UNKNOWN"`.
+     * @deprecated
+     */
+    fieldSet?: Set;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: `PUBLIC`.
+     */
+    fieldsets?: Set[];
+}
+export declare enum Set {
+    /**
+     * Includes `id`, `contactId`, `createdDate`, `updatedDate` and the `profile` object.
+     * `status`, `privacyStatus`, and `activityStatus` are returned as `UNKNOWN`.
+     */
+    PUBLIC = "PUBLIC",
+    /** Includes `id`, `loginEmail`, `status`, `contactId`, `createdDate`, `updatedDate`, `privacyStatus`, `activityStatus` and the `profile` object. */
+    EXTENDED = "EXTENDED",
+    /** Includes all fields. */
+    FULL = "FULL"
+}
+/** Member profile. */
+export interface GetMyMemberResponse {
+    /** The requested member. */
+    member?: Member;
+}
+export interface GetMemberRequest {
+    /** Member ID. */
+    id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Defaults to `PUBLIC`.
+     */
+    fieldsets?: Set[];
+}
+export interface GetMemberResponse {
+    /** The requested member. */
+    member?: Member;
+}
+export interface MemberToMemberBlockedPayload {
+    /** Member ID. */
+    memberId?: string;
+}
+export interface ListMembersRequest {
+    paging?: Paging;
+    /**
+     * Predefined sets of fields to return.
+     *
+     * Default: `PUBLIC`.
+     */
+    fieldsets?: Set[];
+    sorting?: Sorting[];
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export 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;
+}
+export interface ListMembersResponse {
+    /** List of members. */
+    members?: Member[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export 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;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export 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;
+}
+export interface QueryMembersRequest {
+    /** Query options. */
+    query?: Query;
+    /**
+     * Predefined sets of fields to return.
+     *
+     * Default: `PUBLIC`.
+     */
+    fieldsets?: Set[];
+    /** Plain text search. */
+    search?: Search;
+}
+export interface Query {
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    filter?: any;
+    /** Limit number of results */
+    paging?: Paging;
+    /** Sort the results */
+    sorting?: Sorting[];
+}
+/** Free text to match in searchable fields */
+export interface Search {
+    /** Search term or expression. */
+    expression?: string | null;
+    /**
+     * Currently supported fields for search:
+     *
+     * - `loginEmail`
+     * - `contact.firstName`
+     * - `contact.lastName`
+     * - `profile.title`
+     * - `profile.nickname`
+     * - `profile.slug`
+     *
+     * Default: `profile.nickname`.
+     */
+    fields?: string[];
+}
+export interface QueryMembersResponse {
+    /** List of members that met the query filter criteria. */
+    members?: Member[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export interface MuteMemberRequest {
+    /** ID of the member to mute. */
+    id: string;
+}
+export interface MuteMemberResponse {
+    /** Muted member. */
+    member?: Member;
+}
+export interface MemberMuted {
+    /**
+     * Member id who got muted
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface UnmuteMemberRequest {
+    /** ID of the member to unmute. */
+    id: string;
+}
+export interface UnmuteMemberResponse {
+    /** Unmuted member. */
+    member?: Member;
+}
+export interface MemberUnmuted {
+    /**
+     * Member id who got unmuted
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface ApproveMemberRequest {
+    /** ID of the member to approve. */
+    id: string;
+}
+export interface ApproveMemberResponse {
+    /** Approved member. */
+    member?: Member;
+}
+export interface MemberApproved {
+    /**
+     * Member id who got approved
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface BlockMemberRequest {
+    /** ID of a member to block. */
+    id: string;
+}
+export interface BlockMemberResponse {
+    /** Blocked member. */
+    member?: Member;
+}
+export interface MemberBlocked {
+    /**
+     * Member id who got blocked
+     * @readonly
+     */
+    memberId?: string;
+}
+export interface MemberSelfBlockForbiddenPayload {
+    /** Target's member ID. */
+    memberId?: string;
+}
+export interface OwnerMemberBlockForbiddenPayload {
+    /** Owner's member ID. */
+    memberId?: string;
+}
+export interface ActiveSubscriptionMemberBlockForbiddenPayload {
+    /** Active subscription member ID. */
+    memberId?: string;
+}
+export interface DisconnectMemberRequest {
+    /** ID of a member to disconnect. */
+    id: string;
+}
+export interface DisconnectMemberResponse {
+    /** Disconnected member. */
+    member?: Member;
+}
+export interface DeleteMemberRequest {
+    /** ID of the member to delete. */
+    id: string;
+}
+export interface DeleteMemberResponse {
+}
+export interface ContentReassignmentRequested {
+    fromMember?: Member;
+    toMember?: Member;
+}
+export interface ContentDeletionRequested {
+    member?: Member;
+}
+export interface OwnerOrContributorDeleteForbiddenPayload {
+    /** Owner's or contributor's member ID. */
+    memberId?: string;
+}
+export interface ActiveSubscriptionMemberDeleteForbiddenPayload {
+    /** Active subscription member ID. */
+    memberId?: string;
+}
+export interface DeleteMyMemberRequest {
+    /** ID of a member receiving deleted member's content. */
+    contentAssigneeId?: string | null;
+}
+export interface DeleteMyMemberResponse {
+}
+export interface BulkDeleteMembersRequest {
+    /** IDs of members to be deleted. */
+    memberIds: string[];
+}
+export interface BulkDeleteMembersResponse {
+    /** Result. */
+    results?: BulkMemberResult[];
+    /** Bulk action result metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkMemberResult {
+    itemMetadata?: ItemMetadata;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface BulkDeleteMembersByFilterRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    filter: any;
+    /** ID of a member receiving the deleted member's content. */
+    contentAssigneeId?: string | null;
+    /** Plain text search. */
+    search?: Search;
+}
+export interface BulkDeleteMembersByFilterResponse {
+    /**
+     * Job ID.
+     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     */
+    jobId?: string;
+}
+export interface BulkApproveMembersRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    filter: any;
+}
+export interface BulkApproveMembersResponse {
+    /**
+     * Job ID.
+     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     */
+    jobId?: string;
+}
+export interface BulkBlockMembersRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */
+    filter: any;
+}
+export interface BulkBlockMembersResponse {
+    /**
+     * Job ID.
+     * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
+     */
+    jobId?: string;
+}
+export interface CreateMemberRequest {
+    /** Member to create. */
+    member?: Member;
+}
+export interface CreateMemberResponse {
+    /** New member. */
+    member?: Member;
+}
+export interface UpdateMemberRequest {
+    /** Member to update. */
+    member?: Member;
+}
+export interface UpdateMemberResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface InvalidCustomFieldUrlPayload {
+    /** Custom field key and invalid URL. */
+    fields?: Record<string, string>;
+}
+export interface DeleteMemberPhonesRequest {
+    /** ID of the member whose phone numbers will be deleted. */
+    id: string;
+}
+export interface DeleteMemberPhonesResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface DeleteMemberEmailsRequest {
+    /** ID of the member whose email addresses will be deleted. */
+    id: string;
+}
+export interface DeleteMemberEmailsResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface DeleteMemberAddressesRequest {
+    /** ID of the member whose street addresses will be deleted. */
+    id: string;
+}
+export interface DeleteMemberAddressesResponse {
+    /** Updated member. */
+    member?: Member;
+}
+export interface Empty {
+}
+export 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 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 */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export 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 */
+export 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;
+}
+export 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;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export 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;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
+}
+/** Site transferred to another user. */
+export 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. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export 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;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export 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.
+ */
+export 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;
+}
+export 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. */
+export 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.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+export interface MemberOwnershipTransferred {
+    fromMember?: Member;
+    toMember?: Member;
+}
+export interface MemberIdChanged {
+    fromId?: string;
+    toId?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export 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 */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface StreetAddressNonNullableFields {
+    number: string;
+    name: string;
+}
+interface AddressNonNullableFields {
+    streetAddress?: StreetAddressNonNullableFields;
+}
+interface ContactNonNullableFields {
+    addresses: AddressNonNullableFields[];
+}
+interface ImageNonNullableFields {
+    id: string;
+    url: string;
+    height: number;
+    width: number;
+}
+interface ProfileNonNullableFields {
+    photo?: ImageNonNullableFields;
+    cover?: ImageNonNullableFields;
+}
+interface MemberNonNullableFields {
+    status: Status;
+    contact?: ContactNonNullableFields;
+    profile?: ProfileNonNullableFields;
+    privacyStatus: PrivacyStatusStatus;
+    activityStatus: ActivityStatusStatus;
+}
+export interface UpdateMySlugResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface UpdateMemberSlugResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface JoinCommunityResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface LeaveCommunityResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface GetMyMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface GetMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface ListMembersResponseNonNullableFields {
+    members: MemberNonNullableFields[];
+}
+export interface QueryMembersResponseNonNullableFields {
+    members: MemberNonNullableFields[];
+}
+export interface MuteMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface UnmuteMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface ApproveMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface BlockMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface DisconnectMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkMemberResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface BulkDeleteMembersResponseNonNullableFields {
+    results: BulkMemberResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface BulkDeleteMembersByFilterResponseNonNullableFields {
+    jobId: string;
+}
+export interface BulkApproveMembersResponseNonNullableFields {
+    jobId: string;
+}
+export interface BulkBlockMembersResponseNonNullableFields {
+    jobId: string;
+}
+export interface CreateMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface UpdateMemberResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface DeleteMemberPhonesResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface DeleteMemberEmailsResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export interface DeleteMemberAddressesResponseNonNullableFields {
+    member?: MemberNonNullableFields;
+}
+export {};