@wix/groups 1.0.66 → 1.0.68

package/build/es/src/social-groups-v2-join-group-request.types.d.ts

@@ -1,411 +0,0 @@
-/**
- * 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 {
-    /**
-     * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
-     * @readonly
-     */
-    siteMemberId?: string;
-    /** @readonly */
-    contactId?: string;
-    /**
-     * Join group request status.
-     * - `PENDING` - Pending join group request.
-     * - `APPROVED` - Approved join group request.
-     * - `REJECTED` - Rejected join group request.
-     * - `CANCELED` - Canceled join group request.
-     */
-    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 has been 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 {
-    /** Group ID. */
-    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 {
-    /** Relevant group. */
-    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 {
-    /** Relevant group. */
-    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 {
-    /** Relevant group. */
-    groupId: string;
-    /**
-     * __Deprecated.__ Use `memberIds` instead.
-     * This parameter will be removed on June 30, 2022.
-     *
-     * Required if `memberIds` is not provided.
-     */
-    siteMemberIds?: string[];
-    /**
-     * Member IDs to approve.
-     *
-     * <blockquote class='important'>
-     *
-     * __Important:__
-     * This parameter will be required after the deprecated `siteMemberIds` is removed
-     * on June 30, 2022.
-     *
-     * </blockquote>
-     */
-    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 {
-    /** Relevant group. */
-    groupId: string;
-    /** Rejection data. */
-    rejections?: Rejection[];
-}
-export interface Rejection {
-    /** Member ID to reject. */
-    memberId?: string;
-    /** Rejection reason. Free text that will be displayed to the rejected site member (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 {
-    /** Group ID. */
-    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 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 QueryJoinGroupRequestsRequest {
-    /** 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 QueryJoinGroupRequestsResponse {
-    /** Join group requests. */
-    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 extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
-    id?: string;
-    /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
-     */
-    entityFqdn?: string;
-    /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp. */
-    eventTime?: Date;
-    /**
-     * 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;
-}
-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 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;
-    }[];
-}

package/build/es/src/social-groups-v2-join-group-request.types.js

@@ -1,45 +0,0 @@
-export var RequestStatus;
-(function (RequestStatus) {
-    RequestStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
-    /** Pending request. */
-    RequestStatus["PENDING"] = "PENDING";
-    /** Approved request. */
-    RequestStatus["APPROVED"] = "APPROVED";
-    /** Rejected request. */
-    RequestStatus["REJECTED"] = "REJECTED";
-    /** Cancelled request. */
-    RequestStatus["CANCELLED"] = "CANCELLED";
-    /** Canceled request. */
-    RequestStatus["CANCELED"] = "CANCELED";
-})(RequestStatus || (RequestStatus = {}));
-export var ViolationType;
-(function (ViolationType) {
-    ViolationType["NONE"] = "NONE";
-    ViolationType["NOT_LOGGED_IN"] = "NOT_LOGGED_IN";
-    ViolationType["ALREADY_JOINED"] = "ALREADY_JOINED";
-    ViolationType["SECRET_GROUP"] = "SECRET_GROUP";
-    ViolationType["EVENTS"] = "EVENTS";
-    ViolationType["PRICING_PlANS"] = "PRICING_PlANS";
-    ViolationType["MEMBERSHIP_QUESTIONS"] = "MEMBERSHIP_QUESTIONS";
-    ViolationType["ADMIN_APPROVAL"] = "ADMIN_APPROVAL";
-})(ViolationType || (ViolationType = {}));
-export var ItemsToUpdate;
-(function (ItemsToUpdate) {
-    /** Take into account only items which are listed in request. */
-    ItemsToUpdate["BY_ID"] = "BY_ID";
-    /** Update all items. */
-    ItemsToUpdate["ALL_ITEMS"] = "ALL_ITEMS";
-})(ItemsToUpdate || (ItemsToUpdate = {}));
-export var OwnershipFilter;
-(function (OwnershipFilter) {
-    /** All items. */
-    OwnershipFilter["ALL"] = "ALL";
-    /** Items for current site member. */
-    OwnershipFilter["CURRENT_MEMBER"] = "CURRENT_MEMBER";
-})(OwnershipFilter || (OwnershipFilter = {}));
-export var SortOrder;
-(function (SortOrder) {
-    SortOrder["ASC"] = "ASC";
-    SortOrder["DESC"] = "DESC";
-})(SortOrder || (SortOrder = {}));
-//# sourceMappingURL=social-groups-v2-join-group-request.types.js.map

package/build/es/src/social-groups-v2-join-group-request.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"social-groups-v2-join-group-request.types.js","sourceRoot":"","sources":["../../../src/social-groups-v2-join-group-request.types.ts"],"names":[],"mappings":"AAwBA,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,uBAAuB;IACvB,oCAAmB,CAAA;IACnB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,wBAAwB;IACxB,sCAAqB,CAAA;IACrB,yBAAyB;IACzB,wCAAuB,CAAA;IACvB,wBAAwB;IACxB,sCAAqB,CAAA;AACvB,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AA6ED,MAAM,CAAN,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,gDAA+B,CAAA;IAC/B,kDAAiC,CAAA;IACjC,8CAA6B,CAAA;IAC7B,kCAAiB,CAAA;IACjB,gDAA+B,CAAA;IAC/B,8DAA6C,CAAA;IAC7C,kDAAiC,CAAA;AACnC,CAAC,EATW,aAAa,KAAb,aAAa,QASxB;AAsFD,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,gCAAe,CAAA;IACf,wBAAwB;IACxB,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AA+CD,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,iBAAiB;IACjB,8BAAW,CAAA;IACX,qCAAqC;IACrC,oDAAiC,CAAA;AACnC,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AAuDD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}