export interface GroupMember { /** * Member ID. See the Members API for more details. * @readonly */ memberId?: string; /** Group member role. */ role?: GroupRole; /** * Date and time the group Member joined the group. * @readonly */ joinedDate?: Date | null; } /** * A group member may have multiple roles in a single group. * Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future. */ export interface GroupRole { /** Member's role. */ value?: Role; } export declare enum Role { /** Regular group member. */ MEMBER = "MEMBER", /** Group administrator. */ ADMIN = "ADMIN" } export interface SocialGroupsEvent extends SocialGroupsEventPayloadOneOf { memberJoined?: MemberJoinedGroup; membersAdded?: MembersAddedToGroup; joinRequestsApproved?: JoinRequestsApproved; membersInvited?: MembersInvitedToGroup; } /** @oneof */ export interface SocialGroupsEventPayloadOneOf { memberJoined?: MemberJoinedGroup; membersAdded?: MembersAddedToGroup; joinRequestsApproved?: JoinRequestsApproved; membersInvited?: MembersInvitedToGroup; } export interface MemberJoinedGroup { groupId?: string; groupsInstanceId?: string; siteMemberId?: string; } export interface MembersAddedToGroup { groupId?: string; groupsInstanceId?: string; whoAddedId?: string | null; siteMemberIds?: string[]; /** Used for Apes sticky experiment */ operationId?: string; } export interface JoinRequestsApproved { groupId?: string; groupsInstanceId?: string; siteMemberIds?: string[]; /** Used for Apes sticky experiment */ operationId?: string; } export interface MembersInvitedToGroup { groupId?: string; groupsInstanceId?: string; siteMemberIds?: string[]; } /** ID of the group to join. */ export interface JoinRequest { groupId?: string; /** Answers to membership questions. A Join Request will fail, if the answer to a required question is omitted. */ membershipQuestionAnswers?: MembershipQuestionAnswer[]; autoInviteId?: string | null; } /** Answer to a membership question. */ export interface MembershipQuestionAnswer { /** Question ID. */ id?: string; /** Answer text. */ text?: string | null; } export interface JoinResponse { /** New member. */ member?: GroupMember; } export interface MemberJoined { /** Group ID that member has joined. */ groupId?: string; /** Joined group member. */ groupMember?: GroupMember; } export declare enum JoinBy { MANUALLY = "MANUALLY", PERSONAL_INVITE_LINK = "PERSONAL_INVITE_LINK", PUBLIC_INVITE_LINK = "PUBLIC_INVITE_LINK" } export interface LeaveRequest { /** ID of the Group to leave. */ groupId?: string; } export interface LeaveResponse { } export interface MemberLeft { /** Group ID that member has left. */ groupId?: string; /** Group member that left. */ groupMember?: GroupMember; } export interface AddGroupMembersRequest { /** Group ID. */ groupId: string; /** Member IDs. See the Members API for details. */ memberIds?: string[]; } export interface AddGroupMembersResponse { /** New members. */ members?: GroupMember[]; } export interface MemberAdded { /** Group ID that member was added to. */ groupId?: string; /** Added group member. */ groupMember?: GroupMember; } export interface RemoveGroupMembersRequest { /** Group ID. */ groupId: string; /** Member IDs. See the Members API for details. */ memberIds?: string[]; } export interface RemoveGroupMembersResponse { } export interface MemberRemoved { /** Group ID that member was removed from. */ groupId?: string; /** Removed group member. */ groupMember?: GroupMember; } export interface ListGroupMembersRequest { /** Group ID. */ groupId: string; /** Number of items to load. Maximum `100`. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface ListGroupMembersResponse { /** Retrieved members. */ members?: GroupMember[]; /** Paging information. */ 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 QueryGroupMembersRequest { /** Group ID. */ groupId: string; query?: Query; } export interface Query { /** * 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?: any; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting[]; /** Paging options to limit and skip the number of items. */ paging?: Paging; /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */ fields?: string[]; /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */ fieldsets?: string[]; } 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 Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface QueryGroupMembersResponse { /** Group members. */ members?: GroupMember[]; /** Paging information. */ metadata?: PagingMetadata; } export interface QueryNonGroupMembersRequest { /** Group ID. */ groupId?: string; query?: Query; } export interface QueryNonGroupMembersResponse { /** Retrieved members. */ members?: GroupMember[]; } export interface ListMembershipsRequest { /** Member ID. See the Members API for details. */ memberId: string | null; /** Number of items to load. Maximum `100`. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface ListMembershipsResponse { /** Site member's memberships. */ memberships?: Membership[]; /** Paging information. */ metadata?: PagingMetadata; } export interface Membership { /** * Group ID. * @readonly */ groupId?: string; /** Membership status with group. */ status?: MembershipStatus; /** Group member role. When membership status is not `JOINED`, this is empty. */ role?: GroupRole; } export declare enum MembershipStatus { /** Undefined membership status. */ UNKNOWN_STATUS = "UNKNOWN_STATUS", /** Site member is a group member. */ JOINED = "JOINED", /** Site member has submitted a request to join this group. The request is still `PENDING`. */ PENDING = "PENDING" } export interface QueryMembershipsRequest { /** Member ID. See the Members API for details. */ memberId: string | null; query?: Query; } export interface QueryMembershipsResponse { /** Site member's memberships. */ memberships?: Membership[]; /** Paging information. */ metadata?: PagingMetadata; } export interface QueryMyMembershipRequest { query?: Query; } export interface QueryMyMembershipResponse { /** Site member's memberships. */ memberships?: Membership[]; /** Paging information. */ metadata?: PagingMetadata; } 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 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 GroupRoleNonNullableFields { value: Role; } interface GroupMemberNonNullableFields { siteMemberId: string; memberId: string; role?: GroupRoleNonNullableFields; } export interface AddGroupMembersResponseNonNullableFields { members: GroupMemberNonNullableFields[]; } export interface ListGroupMembersResponseNonNullableFields { members: GroupMemberNonNullableFields[]; } export interface QueryGroupMembersResponseNonNullableFields { members: GroupMemberNonNullableFields[]; } interface MembershipNonNullableFields { groupId: string; status: MembershipStatus; role?: GroupRoleNonNullableFields; } export interface ListMembershipsResponseNonNullableFields { memberships: MembershipNonNullableFields[]; } export interface QueryMembershipsResponseNonNullableFields { memberships: MembershipNonNullableFields[]; } export {};