@wix/groups 1.0.67 → 1.0.68

package/build/cjs/src/social-groups-v2-join-group-request.universal.d.ts

@@ -1,541 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/**
- * To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin.
- * When the request is approved, the site member becomes a group member.
- */
-export interface JoinGroupRequest {
-    /**
-     * Site member ID of the requester.
-     * @readonly
-     */
-    siteMemberId?: string;
-    /** @readonly */
-    contactId?: string;
-    /**
-     * Status of the request to join a group.
-     *
-     * One of:
-     * - `"PENDING"`
-     * - `"APPROVED"`
-     * - `"REJECTED"`
-     */
-    status?: RequestStatus;
-    /** Join group request details. */
-    requestDetails?: RequestDetails;
-}
-export declare enum RequestStatus {
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Pending request. */
-    PENDING = "PENDING",
-    /** Approved request. */
-    APPROVED = "APPROVED",
-    /** Rejected request. */
-    REJECTED = "REJECTED",
-    /** Cancelled request. */
-    CANCELLED = "CANCELLED",
-    /** Canceled request. */
-    CANCELED = "CANCELED"
-}
-export interface RequestDetails {
-    /** Reason the request to join a group was rejected. */
-    rejectionReason?: string | null;
-}
-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[];
-}
-export interface GetJoinRequirementsRequest {
-    /** ID of the group requested to join. */
-    groupId?: string;
-    /** Answers to membership questions. They can be empty, but submit join group request will fail if an 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 GetJoinRequirementsResponse {
-    violation?: Violation;
-}
-export interface PaidPlan {
-    planId?: string;
-    name?: string;
-    startsAt?: Date;
-}
-export declare enum ViolationType {
-    NONE = "NONE",
-    NOT_LOGGED_IN = "NOT_LOGGED_IN",
-    ALREADY_JOINED = "ALREADY_JOINED",
-    SECRET_GROUP = "SECRET_GROUP",
-    EVENTS = "EVENTS",
-    PRICING_PlANS = "PRICING_PlANS",
-    MEMBERSHIP_QUESTIONS = "MEMBERSHIP_QUESTIONS",
-    ADMIN_APPROVAL = "ADMIN_APPROVAL"
-}
-export interface EventsViolationOptions {
-    /** Events which allow user to join the group. */
-    eventIds?: string[];
-}
-export interface PricingPlanViolationOptions {
-    installed?: boolean;
-    /** Plan ids which allow user to join the group. */
-    requiredPlans?: PaidPlan[];
-    /** Plan ids which user have, but they don't allow to join group right now, because they start some time in the future. */
-    futurePlans?: PaidPlan[];
-}
-export interface MembershipQuestionViolationOptions {
-    requiredQuestionIds?: string[];
-}
-export interface Violation extends ViolationViolationOptionsOneOf {
-    eventsOptions?: EventsViolationOptions;
-    pricingPlansOptions?: PricingPlanViolationOptions;
-    membershipQuestionsOptions?: MembershipQuestionViolationOptions;
-    violationType?: ViolationType;
-}
-/** @oneof */
-export interface ViolationViolationOptionsOneOf {
-    eventsOptions?: EventsViolationOptions;
-    pricingPlansOptions?: PricingPlanViolationOptions;
-    membershipQuestionsOptions?: MembershipQuestionViolationOptions;
-}
-export interface SubmitJoinGroupRequestRequest {
-    /** ID of the group requested to join. */
-    groupId?: string;
-    /** Answers to membership questions. They can be empty, but submit join group request will fail if an answer to a required question is omitted. */
-    membershipQuestionAnswers?: MembershipQuestionAnswer[];
-}
-export interface SubmitJoinGroupRequestResponse {
-    /** Submitted join group request. */
-    joinGroupRequest?: JoinGroupRequest;
-}
-export interface CancelJoinGroupRequestRequest {
-    /** ID of the group requested to join. */
-    groupId?: string;
-}
-export interface CancelJoinGroupRequestResponse {
-    /** Cancelled join group request. */
-    joinGroupRequest?: JoinGroupRequest;
-}
-export interface JoinGroupRequestCancelled {
-    /** Group ID for which join request was cancelled. */
-    groupId?: string;
-    /** Cancelled join group request. */
-    joinGroupRequest?: JoinGroupRequest;
-}
-export interface ApproveJoinGroupRequestsRequest {
-    /** ID of the group requested to join. */
-    groupId: string;
-    /**
-     * @Internal
-     * @Internal */
-    siteMemberIds?: string[];
-    /** IDs of the site members to approve. */
-    memberIds?: string[];
-}
-export declare enum ItemsToUpdate {
-    /** Take into account only items which are listed in request. */
-    BY_ID = "BY_ID",
-    /** Update all items. */
-    ALL_ITEMS = "ALL_ITEMS"
-}
-export interface ApproveJoinGroupRequestsResponse {
-    /** Approved join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-}
-export interface JoinGroupRequestApproved {
-    /** Group ID for which join request was approved. */
-    groupId?: string;
-    /** Approved join group request. */
-    joinGroupRequest?: JoinGroupRequest;
-}
-export interface RejectJoinGroupRequestsRequest {
-    /** ID of the group requested to join. */
-    groupId: string;
-    /** Rejection data. */
-    rejections?: Rejection[];
-}
-export interface Rejection {
-    /** Member ID to reject. */
-    memberId?: string;
-    /** Reason the request to join a group was rejected. Text written by the request reviewer that is displayed when the group is rejected (max 1,000 characters). */
-    reason?: string | null;
-}
-export interface RejectJoinGroupRequestsResponse {
-    /** Rejected join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-}
-export interface JoinGroupRequestRejected {
-    /** Group ID for which join request was rejected. */
-    groupId?: string;
-    /** Rejected join group request. */
-    joinGroupRequest?: JoinGroupRequest;
-}
-export interface ListJoinGroupRequestsRequest {
-    /** ID of the group requested to join. */
-    groupId: string;
-    limit?: number | null;
-    offset?: number | null;
-}
-export declare enum OwnershipFilter {
-    /** All items. */
-    ALL = "ALL",
-    /** Items for current site member. */
-    CURRENT_MEMBER = "CURRENT_MEMBER"
-}
-export interface ListJoinGroupRequestsResponse {
-    /** Join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-    metadata?: PagingMetadata;
-}
-export interface PagingMetadata {
-    /** Number of items in the current results page. */
-    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 QueryJoinGroupRequestsRequest {
-    /** ID of the group requested to join. */
-    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 QueryJoinGroupRequestsResponse {
-    /** Requests to join a group. */
-    joinGroupRequests?: JoinGroupRequest[];
-    metadata?: PagingMetadata;
-}
-export interface RejectAllJoinGroupRequestsRequest {
-}
-export interface RejectAllJoinGroupRequestsResponse {
-    /** Rejected join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-}
-export interface ApproveAllJoinGroupRequestsRequest {
-}
-export interface ApproveAllJoinGroupRequestsResponse {
-    /** Rejected join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-}
-export interface ListAllJoinGroupRequestsRequest {
-    query?: Query;
-}
-export interface ListAllJoinGroupRequestsResponse {
-    /** Join group requests. */
-    joinGroupRequests?: JoinGroupRequest[];
-    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 ApproveJoinGroupRequestsResponseNonNullableFields {
-    joinGroupRequests: {
-        siteMemberId: string;
-        contactId: string;
-        status: RequestStatus;
-    }[];
-}
-export interface RejectJoinGroupRequestsResponseNonNullableFields {
-    joinGroupRequests: {
-        siteMemberId: string;
-        contactId: string;
-        status: RequestStatus;
-    }[];
-}
-export interface ListJoinGroupRequestsResponseNonNullableFields {
-    joinGroupRequests: {
-        siteMemberId: string;
-        contactId: string;
-        status: RequestStatus;
-    }[];
-}
-export interface QueryJoinGroupRequestsResponseNonNullableFields {
-    joinGroupRequests: {
-        siteMemberId: string;
-        contactId: string;
-        status: RequestStatus;
-    }[];
-}
-export declare const onJoinGroupRequestCreated: EventDefinition<DomainCreatedEvent<JoinGroupRequest>, "wix.social_groups.v2.join_group_request_created">;
-export declare const onJoinGroupRequestApproved: EventDefinition<DomainActionEvent<JoinGroupRequestApproved>, "wix.social_groups.v2.join_group_request_approved">;
-export declare const onJoinGroupRequestRejected: EventDefinition<DomainActionEvent<JoinGroupRequestRejected>, "wix.social_groups.v2.join_group_request_rejected">;
-/**
- * Approves requests to join a group.
- *
- * > **Note:** This function is only relevant for private groups.
- *
- * The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
- * Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
- *
- * <!--
- * > **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can approve site member requests to join a group.
- * -->
- * @param memberIds - IDs of the site members to approve.
- * @public
- * @requiredField groupId
- * @requiredField memberIds
- * @param groupId - ID of the group requested to join.
- */
-export declare function approveJoinGroupRequests(groupId: string, memberIds: string[], options?: ApproveJoinGroupRequestsOptions): Promise<ApproveJoinGroupRequestsResponse & ApproveJoinGroupRequestsResponseNonNullableFields>;
-export interface ApproveJoinGroupRequestsOptions {
-    /**
-     * @Internal
-     * @Internal */
-    siteMemberIds?: string[];
-}
-/**
- * Rejects requests to join a group.
- *
- * > **Note:**  This function is only relevant for private groups.
- *
- * The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
- * Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
- *
- * <!--
- * > **Note:** If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can reject site member requests to join a group.
- * -->
- *
- * @param rejections - Rejection data.
- * @public
- * @requiredField groupId
- * @requiredField rejections
- * @param groupId - ID of the group requested to join.
- */
-export declare function rejectJoinGroupRequests(groupId: string, rejections: Rejection[]): Promise<RejectJoinGroupRequestsResponse & RejectJoinGroupRequestsResponseNonNullableFields>;
-/**
- * Lists requests to join a group.
- *
- * > **Note:** This function is only relevant for private groups.
- *
- * The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
- * Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
- *
- * > **Notes:**
- * <!-- > + If the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can see requests to join a group. -->
- * @public
- * @requiredField groupId
- * @param groupId - ID of the group requested to join.
- */
-export declare function listJoinGroupRequests(groupId: string, options?: ListJoinGroupRequestsOptions): Promise<ListJoinGroupRequestsResponse & ListJoinGroupRequestsResponseNonNullableFields>;
-export interface ListJoinGroupRequestsOptions {
-    limit?: number | null;
-    offset?: number | null;
-}
-/**
- * Creates a query to retrieve a list of join requests.
- *
- * > **Notes:**
- * + This function is only relevant for private groups.
- * + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
- *
- * The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
- *
- * The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
- *
- * You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
- *
- * The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
- *
- * `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
- * + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
- *
- * The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
- *
- * | Property                    | Supported Filters & Sorting                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
- * | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
- * | `status`                    | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or)                                |
- *
- * @public
- * @requiredField groupId
- * @param groupId - Group ID.
- */
-export declare function queryJoinGroupRequests(groupId: string, options?: QueryJoinGroupRequestsOptions): JoinGroupRequestsQueryBuilder;
-export interface QueryJoinGroupRequestsOptions {
-}
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface JoinGroupRequestsQueryResult extends QueryOffsetResult {
-    items: JoinGroupRequest[];
-    query: JoinGroupRequestsQueryBuilder;
-    next: () => Promise<JoinGroupRequestsQueryResult>;
-    prev: () => Promise<JoinGroupRequestsQueryResult>;
-}
-export interface JoinGroupRequestsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: 'status', value: any[]) => JoinGroupRequestsQueryBuilder;
-    in: (propertyName: 'status', value: any) => JoinGroupRequestsQueryBuilder;
-    exists: (propertyName: 'status', value: boolean) => JoinGroupRequestsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => JoinGroupRequestsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => JoinGroupRequestsQueryBuilder;
-    find: () => Promise<JoinGroupRequestsQueryResult>;
-}
-export {};