@wix/groups 1.0.67 → 1.0.69

package/build/cjs/src/social-groups-v2-group.types.d.ts

@@ -1,778 +0,0 @@
-export interface Group {
-    /**
-     * Group ID.
-     * @readonly
-     */
-    id?: string | null;
-    /** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
-    slug?: string | null;
-    /**
-     * __Deprecated.__ Use `privacyStatus` instead.
-     * This property will be removed on June 30, 2022.
-     */
-    privacyLevel?: PrivacyStatus;
-    /**
-     * Group privacy status.
-     * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.
-     * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.
-     * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.
-     */
-    privacyStatus?: PrivacyStatus;
-    /**
-     * __Deprecated.__ Use `name` instead.
-     * This property will be removed on June 30, 2022.
-     */
-    title?: string | null;
-    /** Group name. */
-    name?: string | null;
-    /** Group description in DraftJS format. */
-    description?: string | null;
-    /** Group teaser. */
-    teaser?: string | null;
-    /**
-     * __Deprecated.__
-     * For `details.logo`, use `coverImage` instead.
-     * For `details.membersTitle`, `memberTitle` instead.
-     * This property will be removed on June 30, 2022.
-     */
-    details?: GroupDetails;
-    /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
-    memberTitle?: string | null;
-    /** Cover image. You cannot upload your own cover image. */
-    coverImage?: CoverImage;
-    /** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */
-    settings?: GroupSettings;
-    /**
-     * Total count of current group members.
-     * @readonly
-     */
-    membersCount?: number | null;
-    /**
-     * __Deprecated.__ Use `ownerId` instead.
-     * This property will be removed on June 30, 2022.
-     * @readonly
-     */
-    createdBy?: Identity;
-    /**
-     * Group owner.
-     * @readonly
-     */
-    ownerId?: string | null;
-    /**
-     * Group creation date and time.
-     * @readonly
-     */
-    createdDate?: Date;
-    /**
-     * Date and time of the latest group update.
-     * @readonly
-     */
-    updatedDate?: Date;
-    /**
-     * __Deprecated.__ Use `lastActivityDate` instead.
-     * This property will be removed on June 30, 2022.
-     * @readonly
-     */
-    recentActivityDate?: Date;
-    /**
-     * Date and time of the most recent group activity, for example a post or comment.
-     * @readonly
-     */
-    lastActivityDate?: Date;
-}
-export declare enum Type {
-    UNKNOWN = "UNKNOWN",
-    ADMIN_APPROVAL = "ADMIN_APPROVAL",
-    PAID_PLANS = "PAID_PLANS",
-    EVENTS = "EVENTS"
-}
-export interface Events {
-    eventIds?: string[];
-}
-export interface Logo {
-    /** Logo image ID (for internal use). */
-    mediaId?: string | null;
-    /** Logo image width. */
-    width?: number | null;
-    /** Logo image height. */
-    height?: number | null;
-}
-export interface GroupDetailsPosition {
-    /** horizontal coordinate */
-    x?: number;
-    /** vertical coordinate */
-    y?: number;
-}
-export interface Image {
-    /** Image ID (for internal use). */
-    mediaId?: string | null;
-    /** Image width. */
-    width?: number | null;
-    /** Image height. */
-    height?: number | null;
-}
-export interface Position {
-    /** horizontal coordinate */
-    x?: number;
-    /** vertical coordinate */
-    y?: number;
-}
-export declare enum AllowPolicy {
-    UNKNOWN = "UNKNOWN",
-    OWNER_AND_ADMINS = "OWNER_AND_ADMINS",
-    OWNER = "OWNER",
-    ALL_MEMBERS = "ALL_MEMBERS"
-}
-export interface OnboardingStepSettings {
-    stepKey?: StepKey;
-    visible?: boolean;
-}
-export declare enum StepKey {
-    UNKNOWN = "UNKNOWN",
-    CREATE_POST = "CREATE_POST",
-    REACT_TO_POST = "REACT_TO_POST",
-    INVITE_MEMBERS = "INVITE_MEMBERS"
-}
-export declare enum PrivacyStatus {
-    UNKNOWN = "UNKNOWN",
-    /** Anyone can see the group in the group list and view its content. Anyone can join. */
-    PUBLIC = "PUBLIC",
-    /** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */
-    PRIVATE = "PRIVATE",
-    /** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */
-    SECRET = "SECRET"
-}
-export interface AccessRestriction extends AccessRestrictionDataOneOf {
-    events?: Events;
-    type?: Type;
-}
-/** @oneof */
-export interface AccessRestrictionDataOneOf {
-    events?: Events;
-}
-export interface GroupDetails {
-    /** Group logo. You cannot upload your own logo. */
-    logo?: Logo;
-    /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
-    membersTitle?: string | null;
-}
-export interface CoverImage {
-    /** Cover image. */
-    image?: Image;
-    /** Position of the corner of the cover image (or logo). */
-    position?: Position;
-    /** Position of the corner of the cover image (or logo) for mobile browser. */
-    mobilePosition?: Position;
-}
-export interface GroupSettings {
-    /**
-     * __Deprecated.__ Use `allowedToInviteMembers` instead.
-     * Whether regular members are permitted to invite new members.
-     * If `false`, only admins can invite members. Defaults to `true`.
-     */
-    membersCanInvite?: boolean | null;
-    /**
-     * __Deprecated.__ Use `allowedToApproveJoinRequests` instead.
-     * Whether all group members are permitted to approve join group requests.
-     * If `false`, member approval is limited to the admins.
-     */
-    membersCanApprove?: boolean | null;
-    /**
-     * __Deprecated.__ Use `welcomeMemberPostEnabled` instead.
-     * This property will be removed on June 30, 2022.
-     */
-    memberWelcomePostEnabled?: boolean | null;
-    /** Whether a daily post about new members is enabled. */
-    welcomeMemberPostEnabled?: boolean | null;
-    /** Whether an automatic post about changing the group details is enabled. */
-    groupDetailsChangedPostEnabled?: boolean | null;
-    /** Whether all members can see the full member list. */
-    showMemberList?: boolean | null;
-    onboardingStepsSettings?: OnboardingStepSettings[];
-}
-export interface Identity {
-    /** Member ID of the group creator.  See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
-    id?: string | null;
-    identityType?: IdentityType;
-}
-export declare enum IdentityType {
-    USER = "USER",
-    MEMBER = "MEMBER"
-}
-export interface CreateGroupRequest {
-    /** Group to create. */
-    group: Group;
-    /** ID of the member who created the group. This member will automatically become an admin. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */
-    creatorId?: string | null;
-}
-export interface CreateGroupResponse {
-    /** Created group. */
-    group?: Group;
-}
-export interface UpdateGroupRequest {
-    /** Group to update. */
-    group: Group;
-}
-export interface UpdateGroupResponse {
-    /** Updated group. */
-    group?: Group;
-}
-export interface GroupCoverChanged {
-    oldUrl?: string | null;
-    newUrl?: string | null;
-}
-export interface GroupDescriptionChanged {
-    oldDescription?: string | null;
-    newDescription?: string | null;
-}
-export interface DeleteGroupRequest {
-    /** ID of the group to delete. */
-    groupId: string;
-}
-export interface DeleteGroupResponse {
-    /** Deleted group. */
-    group?: Group;
-}
-export interface GetGroupRequest {
-    /** ID of the group to retrieve. */
-    groupId: string;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export declare enum ContentType {
-    PLAIN_TEXT = "PLAIN_TEXT",
-    DRAFTJS = "DRAFTJS",
-    RICH_CONTENT = "RICH_CONTENT"
-}
-export interface GetGroupResponse {
-    /** Retrieved group. */
-    group?: Group;
-}
-export interface GetGroupBySlugRequest {
-    /** Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive. */
-    slug: string;
-    autoInviteId?: string | null;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export interface GetGroupBySlugResponse {
-    /** Retrieved group. */
-    group?: Group;
-}
-export interface ListGroupsRequest {
-    /** Number of items to load. Maximum `100`. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export interface ListGroupsResponse {
-    /** Retrieved Groups. */
-    groups?: Group[];
-    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 ListGroupsByUserIdRequest {
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export interface ListGroupsByUserIdResponse {
-    groups?: GroupWithMsId[];
-}
-/** Retrieved Groups by metasite id */
-export interface GroupWithMsId {
-    metaSiteId?: string;
-    groups?: Group[];
-}
-export interface QueryGroupsRequest {
-    query?: Query;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-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 QueryGroupsResponse {
-    /** Retrieved groups. */
-    groups?: Group[];
-    metadata?: PagingMetadata;
-}
-export interface QueryJoinedGroupsRequest {
-    query?: Query;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export interface QueryJoinedGroupsResponse {
-    /** Retrieved groups. */
-    groups?: Group[];
-    metadata?: PagingMetadata;
-}
-export interface QueryGroupsByMembershipRequest {
-    query?: Query;
-    membershipStatus?: MembershipStatus;
-    /** Filter groups by permissions. */
-    permissionsFilter?: GroupPermissions;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-export declare enum MembershipStatus {
-    NONE = "NONE",
-    JOINED = "JOINED",
-    PENDING = "PENDING"
-}
-export interface GroupPermissions {
-    canCreatePosts?: boolean | null;
-}
-export interface QueryGroupsByMembershipResponse {
-    /** Retrieved groups. */
-    groups?: Group[];
-    metadata?: PagingMetadata;
-}
-export interface ListGroupIntegrationsDataRequest {
-    groupIds?: string[];
-}
-export interface ListGroupIntegrationsDataResponse {
-    groupsIntegrationsData?: GroupIntegrationsData[];
-}
-export interface GroupIntegrationsData {
-    groupId?: string;
-    feedItemsCount?: number;
-    topicIds?: string[];
-    eventIds?: string[];
-    connectedPricingPlanIds?: string[];
-    onlineProgramIds?: string[];
-}
-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 CreateGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface UpdateGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface DeleteGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface GetGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface GetGroupBySlugResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface ListGroupsResponseNonNullableFields {
-    groups: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    }[];
-}
-export interface QueryGroupsResponseNonNullableFields {
-    groups: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        accessRestriction?: {
-            events?: {
-                eventIds: string[];
-            };
-            type: Type;
-        };
-        details?: {
-            logoPosition?: {
-                x: number;
-                y: number;
-            };
-            mobileLogoPosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            allowedToInviteMembers: AllowPolicy;
-            allowedToApproveJoinRequests: AllowPolicy;
-            allowedToAddMembers: AllowPolicy;
-            allowedToCreatePosts: AllowPolicy;
-            allowedToCommentPosts: AllowPolicy;
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    }[];
-}