@wix/groups 1.0.66 → 1.0.68

package/build/es/src/social-groups-v2-group-member.universal.d.ts

@@ -1,604 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-export interface GroupMember {
-    /**
-     * @internal
-     * @internal
-     * @readonly
-     */
-    siteMemberId?: string;
-    /**
-     * Site member ID.
-     * @readonly
-     */
-    memberId?: string;
-    /** Group Member Role. */
-    role?: GroupRole;
-    /**
-     * Date and time the group Member joined the group.
-     * @readonly
-     */
-    joinedDate?: Date;
-}
-/**
- * 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 {
-    /**
-     * Group member role. One of:
-     * - `"MEMBER"` - Regular group member.
-     * - `"ADMIN"` - Group administrator.
-     */
-    value?: Role;
-}
-export declare enum Role {
-    UNKNOWN_ROLE = "UNKNOWN_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;
-    /**
-     * @internal
-     * @internal */
-    siteMemberIds?: string[];
-    /**
-     * IDs of the site members to add to the group.
-     *
-     *
-     */
-    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;
-    /**
-     * @internal
-     * @internal */
-    siteMemberIds?: string[];
-    /**  IDs of the site members to remove from the group. */
-    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 group members to skip in the list. */
-    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 {
-    /** Site member ID. */
-    memberId: string | null;
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of memberships to skip in the list. */
-    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
-     * - `"JOINED"` - Site member is a group member.
-     * - `"PENDING"` - Site member has submitted a Join Request for this group that is still `"PENDING"`.
-     */
-    status?: MembershipStatus;
-    /** Group member role. When membership status is not `JOINED`, this is empty. */
-    role?: GroupRole;
-}
-export declare enum MembershipStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Site member is a group member. */
-    JOINED = "JOINED",
-    /** Site member has join group request with `PENDING` status for this group. */
-    PENDING = "PENDING"
-}
-export interface QueryMembershipsRequest {
-    /**
-     * @internal
-     * @internal */
-    siteMemberId?: string | null;
-    /** Site member ID. */
-    memberId: string | null;
-    query?: Query;
-}
-export interface QueryMembershipsResponse {
-    /** Site member's memberships. */
-    memberships?: Membership[];
-    /** Paging information. */
-    metadata?: PagingMetadata;
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * 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.
-     */
-    currentEntity?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface AddGroupMembersResponseNonNullableFields {
-    members: {
-        siteMemberId: string;
-        memberId: string;
-        role?: {
-            value: Role;
-        };
-    }[];
-}
-export interface ListGroupMembersResponseNonNullableFields {
-    members: {
-        siteMemberId: string;
-        memberId: string;
-        role?: {
-            value: Role;
-        };
-    }[];
-}
-export interface QueryGroupMembersResponseNonNullableFields {
-    members: {
-        siteMemberId: string;
-        memberId: string;
-        role?: {
-            value: Role;
-        };
-    }[];
-}
-export interface ListMembershipsResponseNonNullableFields {
-    memberships: {
-        groupId: string;
-        status: MembershipStatus;
-        role?: {
-            value: Role;
-        };
-    }[];
-}
-export interface QueryMembershipsResponseNonNullableFields {
-    memberships: {
-        groupId: string;
-        status: MembershipStatus;
-        role?: {
-            value: Role;
-        };
-    }[];
-}
-export declare const onGroupMemberAdded: EventDefinition<DomainActionEvent<MemberAdded>, "wix.social_groups.v2.group_member_added">;
-export declare const onGroupMemberRemoved: EventDefinition<DomainActionEvent<MemberRemoved>, "wix.social_groups.v2.group_member_removed">;
-/**
- * Adds site members to a group.
- *
- *
- * The `addGroupMembers()` function returns a Promise that resolves to the newly-added group member
- * after the member has successfully been added.
- *
- * For `SECRET` groups, site admins, group admins, and group members can add additional members to their group.
- *
- * For `PUBLIC` and `PRIVATE` groups, only site admins and group admins can add additional members to their group. They can also choose to allow all group members to add a new member to the group.
- * This setting can be found in your site's Dashboard under **Groups Application > Your Group > Admin Tools > Member Permissions**.
- *
- * <!-- > **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can add additional members to a group. -->
- *
- * @param groupId - Group ID.
- * @param memberIds - IDs of the site members to add to the group.
- * @public
- * @requiredField groupId
- * @requiredField memberIds
- */
-export declare function addGroupMembers(groupId: string, memberIds: string[], options?: AddGroupMembersOptions): Promise<AddGroupMembersResponse & AddGroupMembersResponseNonNullableFields>;
-export interface AddGroupMembersOptions {
-    /**
-     * @internal
-     * @internal */
-    siteMemberIds?: string[];
-}
-/**
- * Removes members from a group.
- *
- *
- * The `removeGroupMembers()` function returns a Promise that resolves when the member is removed from the group.
- *
- * > **Note:** Only site admins and group admins can remove members from their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten and all site members (including non-group members) can remove members from a group. -->
- *
- * @param groupId - Group ID.
- * @param memberIds - IDs of the site members to remove from the group.
- * @public
- * @requiredField groupId
- * @requiredField memberIds
- */
-export declare function removeGroupMembers(groupId: string, memberIds: string[], options?: RemoveGroupMembersOptions): Promise<void>;
-export interface RemoveGroupMembersOptions {
-    /**
-     * @internal
-     * @internal */
-    siteMemberIds?: string[];
-}
-/**
- * Lists all members of a group.
- *
- *
- *  The `listGroupMembers()` function returns a Promise that resolves to a list of up to 100 group members.
- *  Sorts by default to `joinedDate` in descending order.
- *
- *  > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see the list of group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see the list of group members.  -->
- *  <!-- > + This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify `limit` only, call `listGroupMembers(groupId, paging, null)`. To specify `supressAuth` only, call `listGroupMembers(groupId, null, options)`. -->
- *
- * @param groupId - Group ID.
- * @public
- * @requiredField groupId
- * @param options - Paging options.
- */
-export declare function listGroupMembers(groupId: string, options?: ListGroupMembersOptions): Promise<ListGroupMembersResponse & ListGroupMembersResponseNonNullableFields>;
-export interface ListGroupMembersOptions {
-    /** Maximum number of group members to retrieve. Defaults to 100. */
-    limit?: number | null;
-    /** Number of group members to skip in the list. */
-    offset?: number | null;
-}
-/**
- * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.
- *
- *
- * Creates a query to retrieve a list of group members.
- *
- * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can query group members. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query group members.  -->
- *
- * The `queryGroupMembers()` function builds a query to retrieve a list of all group members, and returns a [GroupMembersQueryBuilder](#membersquerybuilder) object.
- *
- * The returned object contains the query definition which is typically used to run the query using the [`find()`](#membersquerybuilder/find) function.
- *
- * You can refine the query by chaining `GroupMembersQueryBuilder` functions onto the query. `GroupMembersQueryBuilder` functions enable you to sort, filter, and control the results that `queryMembers()` returns.
- *
- *  `queryGroupMembers()` runs with these `GroupMembersQueryBuilder` defaults, which you can override:
- *  + [`limit(100)`](#membersquerybuilder/limit)
- *  + [`descending("joinedDate")`](#membersquerybuilder/descending)
- *
- * The following `GroupMembersQueryBuilder` functions are supported for `queryGroupMembers()`. For a full description of the Members object, see the object returned for the [`items`](#membersqueryresult/items) property in [`GroupMembersQueryResult`](#membersqueryresult).
- *
- * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
- * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `role`                      | [`eq()`](#membersquerybuilder/eq), [`ne()`](#membersquerybuilder/ne)                            |
- * | `joinedDate`                | [`ascending()`](#membersquerybuilder/ascending), [`descending()`](#membersquerybuilder/descending)     |
- *
- *
- * @public
- * @requiredField groupId
- * @param groupId - Group ID.
- */
-export declare function queryGroupMembers(groupId: string): MembersQueryBuilder;
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface MembersQueryResult extends QueryOffsetResult {
-    items: GroupMember[];
-    query: MembersQueryBuilder;
-    next: () => Promise<MembersQueryResult>;
-    prev: () => Promise<MembersQueryResult>;
-}
-export interface MembersQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: 'role', value: any) => MembersQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: 'role', value: any) => MembersQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: 'role', value: any[]) => MembersQueryBuilder;
-    in: (propertyName: 'role', value: any) => MembersQueryBuilder;
-    exists: (propertyName: 'role', value: boolean) => MembersQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    ascending: (...propertyNames: Array<'role' | 'joinedDate'>) => MembersQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: Array<'role' | 'joinedDate'>) => MembersQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => MembersQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => MembersQueryBuilder;
-    find: () => Promise<MembersQueryResult>;
-}
-/**
- * Lists all group memberships of a site member.
- *
- *
- * The `listMemberships()` function returns a Promise that resolves to a list of up to 100 group memberships.
- * Sorts by default to `groupId` in descending order.
- *
- * > **Note:** Only site admins can retrieve a site member's memberships. Site members can see a list of their memberships. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see a list of a site member's memberships. -->
- * <!-- > + This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify `limit` only, call `listMemberships(memberId, paging, null)`. To specify `supressAuth` only, call `listMemberships(memberId, null, options)`. -->
- *
- * @public
- * @requiredField memberId
- * @param memberId - Site member ID.
- * @param options - Paging options.
- */
-export declare function listMemberships(memberId: string | null, options?: ListMembershipsOptions): Promise<ListMembershipsResponse & ListMembershipsResponseNonNullableFields>;
-export interface ListMembershipsOptions {
-    /** Maximum number of memberships to retrieve. Defaults to 100. */
-    limit?: number | null;
-    /** Number of memberships to skip in the list. */
-    offset?: number | null;
-}
-/**
- * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.
- *
- * The queryMemberships function returns a Promise that resolves to a list of memberships.
- *
- * >**Note:** Site members can only query their own memberships.
- *
- * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
- * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `status`                    | [`eq()`](#membershipsquerybuilder/eq), [`ne()`](#membershipsquerybuilder/ne)             |
- * | `role`                      | [`eq()`](#membershipsquerybuilder/eq), [`ne()`](#membershipsquerybuilder/ne)             |
- *
- * @public
- * @requiredField memberId
- * @param memberId - Site member ID.
- */
-export declare function queryMemberships(memberId: string | null, options?: QueryMembershipsOptions): Promise<QueryMembershipsResponse & QueryMembershipsResponseNonNullableFields>;
-export interface QueryMembershipsOptions {
-    /**
-     * @internal
-     * @internal */
-    siteMemberId?: string | null;
-    query?: Query;
-}
-export {};