@wix/groups 1.0.0

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

@@ -0,0 +1,327 @@
+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 Business Manager. */
+    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 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 {
+    type?: Type;
+    events?: Events;
+}
+/** @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 `membersCanInvite` instead.
+     * This property will be removed on June 30, 2022.
+     */
+    membersPermittedToInvite?: boolean | null;
+    /**
+     * Whether regular members are permitted to invite new members.
+     * If `false`, only admins can invite members. Defaults to `true`.
+     */
+    membersCanInvite?: boolean | null;
+    /**
+     * __Deprecated.__ Use `membersCanApprove` instead.
+     * This property will be removed on June 30, 2022.
+     */
+    membersPermittedToApprove?: boolean | null;
+    /**
+     * 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;
+}
+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;
+}
+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;
+}
+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;
+}
+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 {
+}
+export interface ListGroupsByUserIdResponse {
+    groups?: GroupWithMsId[];
+}
+/** Retrieved Groups by metasite id */
+export interface GroupWithMsId {
+    metaSiteId?: string;
+    groups?: Group[];
+}
+export interface QueryGroupsRequest {
+    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 QueryGroupsResponse {
+    /** Retrieved groups. */
+    groups?: Group[];
+    metadata?: PagingMetadata;
+}
+export interface QueryJoinedGroupsRequest {
+    query?: Query;
+}
+export interface QueryJoinedGroupsResponse {
+    /** Retrieved groups. */
+    groups?: Group[];
+    metadata?: PagingMetadata;
+}

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

@@ -0,0 +1,28 @@
+export var Type;
+(function (Type) {
+    Type["UNKNOWN"] = "UNKNOWN";
+    Type["ADMIN_APPROVAL"] = "ADMIN_APPROVAL";
+    Type["PAID_PLANS"] = "PAID_PLANS";
+    Type["EVENTS"] = "EVENTS";
+})(Type || (Type = {}));
+export var PrivacyStatus;
+(function (PrivacyStatus) {
+    PrivacyStatus["UNKNOWN"] = "UNKNOWN";
+    /** Anyone can see the group in the group list and view its content. Anyone can join. */
+    PrivacyStatus["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. */
+    PrivacyStatus["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. */
+    PrivacyStatus["SECRET"] = "SECRET";
+})(PrivacyStatus || (PrivacyStatus = {}));
+export var IdentityType;
+(function (IdentityType) {
+    IdentityType["USER"] = "USER";
+    IdentityType["MEMBER"] = "MEMBER";
+})(IdentityType || (IdentityType = {}));
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+//# sourceMappingURL=social-groups-v2-group.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"social-groups-v2-group.types.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group.types.ts"],"names":[],"mappings":"AAmFA,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,yCAAiC,CAAA;IACjC,iCAAyB,CAAA;IACzB,yBAAiB,CAAA;AACnB,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf;AAsCD,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,wFAAwF;IACxF,kCAAiB,CAAA;IACjB,gKAAgK;IAChK,oCAAmB,CAAA;IACnB,wIAAwI;IACxI,kCAAiB,CAAA;AACnB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB;AAoED,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,iCAAiB,CAAA;AACnB,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAsID,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}