@wix/groups 1.0.66 → 1.0.68

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

@@ -1,869 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-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;
-    /**
-     * @internal
-     * @internal */
-    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;
-    /**
-     * @internal
-     * @internal */
-    title?: string | null;
-    /** Group name. */
-    name?: string | null;
-    /** Group description in DraftJS format. */
-    description?: string | null;
-    /** Group teaser. */
-    teaser?: string | null;
-    /**
-     * @internal
-     * @internal */
-    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;
-    /**
-     * @internal
-     * @internal
-     * @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;
-    /**
-     * @internal
-     * @internal
-     * @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;
-    /**
-     * @internal
-     * @internal */
-    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.  */
-    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<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 CreateGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface UpdateGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface DeleteGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface GetGroupResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface GetGroupBySlugResponseNonNullableFields {
-    group?: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    };
-}
-export interface ListGroupsResponseNonNullableFields {
-    groups: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    }[];
-}
-export interface QueryGroupsResponseNonNullableFields {
-    groups: {
-        privacyLevel: PrivacyStatus;
-        privacyStatus: PrivacyStatus;
-        coverImage?: {
-            position?: {
-                x: number;
-                y: number;
-            };
-            mobilePosition?: {
-                x: number;
-                y: number;
-            };
-        };
-        settings?: {
-            onboardingStepsSettings: {
-                stepKey: StepKey;
-                visible: boolean;
-            }[];
-        };
-        createdBy?: {
-            identityType: IdentityType;
-        };
-    }[];
-}
-export declare const onGroupCreated: EventDefinition<DomainCreatedEvent<Group>, "wix.social_groups.v2.group_created">;
-export declare const onGroupUpdated: EventDefinition<DomainUpdatedEvent<Group>, "wix.social_groups.v2.group_updated">;
-export declare const onGroupCoverChanged: EventDefinition<DomainActionEvent<GroupCoverChanged>, "wix.social_groups.v2.group_group_cover_changed">;
-export declare const onGroupDescriptionChanged: EventDefinition<DomainActionEvent<GroupDescriptionChanged>, "wix.social_groups.v2.group_group_description_changed">;
-export declare const onGroupDeleted: EventDefinition<DomainDeletedEvent<Group>, "wix.social_groups.v2.group_deleted">;
-/**
- * Creates a group.
- *
- *
- * The `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.
- *
- * Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin approval.
- * @param group - Group to create.
- * @public
- * @requiredField group
- * @param options - Optional fields for group creation.
- * @returns Created group.
- */
-export declare function createGroup(group: Group, options?: CreateGroupOptions): Promise<Group & NonNullable<CreateGroupResponseNonNullableFields>['group']>;
-export interface CreateGroupOptions {
-    /** ID of the member who created the group. This member will automatically become an admin.  */
-    creatorId?: string | null;
-}
-/**
- * Updates a group.
- *
- *
- * The `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
- *
- * > **Notes:**
- *
- * - When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.
- * - When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.
- * - When a public or private group's name is updated, the slug is updated to reflect the new group name.
- * @param _id - Group ID.
- * @public
- * @requiredField _id
- * @requiredField group
- * @returns Updated group.
- */
-export declare function updateGroup(_id: string | null, group: UpdateGroup): Promise<Group & NonNullable<UpdateGroupResponseNonNullableFields>['group']>;
-export interface UpdateGroup {
-    /**
-     * Group ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
-    slug?: string | null;
-    /** @internal */
-    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;
-    /** @internal */
-    title?: string | null;
-    /** Group name. */
-    name?: string | null;
-    /** Group description in DraftJS format. */
-    description?: string | null;
-    /** Group teaser. */
-    teaser?: string | null;
-    /** @internal */
-    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;
-    /**
-     * @internal
-     * @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;
-    /**
-     * @internal
-     * @readonly
-     */
-    recentActivityDate?: Date;
-    /**
-     * Date and time of the most recent group activity, for example a post or comment.
-     * @readonly
-     */
-    lastActivityDate?: Date;
-}
-/**
- * Deletes a group.
- *
- *
- * The `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.
- *
- * @param groupId - ID of the group to delete.
- * @public
- * @requiredField groupId
- */
-export declare function deleteGroup(groupId: string): Promise<DeleteGroupResponse & DeleteGroupResponseNonNullableFields>;
-/**
- * Gets a group by ID.
- *
- *
- * The `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.
- *
- * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
- * @param groupId - ID of the group to retrieve.
- * @public
- * @requiredField groupId
- * @returns Retrieved group.
- */
-export declare function getGroup(groupId: string, options?: GetGroupOptions): Promise<Group & NonNullable<GetGroupResponseNonNullableFields>['group']>;
-export interface GetGroupOptions {
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-/**
- * Gets a group by slug.
- *
- *
- * The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.
- *
- * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
- * @param slug - Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive.
- * @public
- * @requiredField slug
- */
-export declare function getGroupBySlug(slug: string, options?: GetGroupBySlugOptions): Promise<GetGroupBySlugResponse & GetGroupBySlugResponseNonNullableFields>;
-export interface GetGroupBySlugOptions {
-    autoInviteId?: string | null;
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType;
-}
-/**
- * Lists groups.
- *
- *
- * The `listGroups()` function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to `_createdDate` in descending order.
- *
- * > **Notes:**
- *
- * - For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.
- * - 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 `listGroups(paging, null)`.
- * @public
- * @param options - Limit and offset options.
- */
-export declare function listGroups(options?: ListGroupsOptions): Promise<ListGroupsResponse & ListGroupsResponseNonNullableFields>;
-export interface ListGroupsOptions {
-    /** 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;
-}
-/**
- * Creates a query to retrieve a list of groups.
- *
- *
- * Note: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content.
- *
- * The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.
- * @public */
-export declare function queryGroups(options?: QueryGroupsOptions): GroupsQueryBuilder;
-export interface QueryGroupsOptions {
-    /** Content type (PLAIN_TEXT returns content as it is) */
-    contentType?: ContentType | undefined;
-}
-interface QueryOffsetResult {
-    currentPage: number | undefined;
-    totalPages: number | undefined;
-    totalCount: number | undefined;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface GroupsQueryResult extends QueryOffsetResult {
-    items: Group[];
-    query: GroupsQueryBuilder;
-    next: () => Promise<GroupsQueryResult>;
-    prev: () => Promise<GroupsQueryResult>;
-}
-export interface GroupsQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    eq: (propertyName: 'title', value: any) => GroupsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     */
-    ne: (propertyName: 'title', value: any) => GroupsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     */
-    startsWith: (propertyName: 'title', value: string) => GroupsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: 'title', value: any[]) => GroupsQueryBuilder;
-    in: (propertyName: 'title', value: any) => GroupsQueryBuilder;
-    exists: (propertyName: 'title', value: boolean) => GroupsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    ascending: (...propertyNames: Array<'title' | 'membersCount' | '_createdDate' | 'recentActivityDate'>) => GroupsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
-    descending: (...propertyNames: Array<'title' | 'membersCount' | '_createdDate' | 'recentActivityDate'>) => GroupsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
-    limit: (limit: number) => GroupsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results. */
-    skip: (skip: number) => GroupsQueryBuilder;
-    find: () => Promise<GroupsQueryResult>;
-}
-export {};