@wix/groups 1.0.5 → 1.0.6

package/build/cjs/src/social-groups-v3-create-request.types.d.ts

@@ -0,0 +1,361 @@
+/**
+ * >**Notes:**
+ * > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.
+ * > + In this situation, site members have to submit a Create Request to create a new group.
+ * > + Create Requests can be approved or rejected by an admin.
+ * > + After a Create Request has been approved, the new group is added to the Group List in the Wix Groups app home page.
+ * > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.
+ */
+export interface CreateRequest {
+    /**
+     * Create request ID
+     * @readonly
+     */
+    id?: string | null;
+    /** Group requested for creation. */
+    group?: Group;
+    /**
+     * Status of request.
+     * - `PENDING` - Pending request.
+     * - `APPROVED` - Approved request.
+     * - `REJECTED` - Rejected request.
+     * - `CANCELED` - Canceled request.
+     */
+    status?: RequestStatus;
+    /** Request details. */
+    requestDetails?: RequestDetails;
+}
+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 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 SubmitCreateRequestRequest {
+    /** Group submitted for creation. */
+    group?: Group;
+}
+export interface SubmitCreateRequestResponse {
+    /** Submitted Create Request. */
+    createRequest?: CreateRequest;
+}
+export interface ApproveCreateRequestsRequest {
+    /** Create Request IDs to approve. Limited to `100`. */
+    createRequestIds?: 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 ApproveCreateRequestsResponse {
+    /** Approved Create Requests. */
+    createRequest?: CreateRequest[];
+}
+export interface CreateRequestApproved {
+    /** Approved create request. */
+    createRequest?: CreateRequest;
+}
+export interface RejectCreateRequestsRequest {
+    /** Rejection data. */
+    rejections?: Rejection[];
+}
+export interface Rejection {
+    /** ID of the Create Request to reject. */
+    createRequestId?: string;
+    /** Rejection reason. Free text displayed to the creator of the rejected Create Request. Limited to 1,000 characters. */
+    reason?: string | null;
+}
+export interface RejectCreateRequestsResponse {
+    /** Rejected Create Requests. */
+    createRequest?: CreateRequest[];
+}
+export interface CreateRequestRejected {
+    /** Rejected create request. */
+    createRequest?: CreateRequest;
+}
+export interface CancelCreateRequestRequest {
+    /** ID of the Create Request to cancel. */
+    createRequestId?: string;
+}
+export interface CancelCreateRequestResponse {
+    /** Canceled Create Request. */
+    createRequest?: CreateRequest;
+}
+export interface ListCreateRequestsRequest {
+    /** Number of items to load. Maximum `100`. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export declare enum OwnershipFilter {
+    /** All items. */
+    ALL = "ALL",
+    /** Items for current site member. */
+    CURRENT_MEMBER = "CURRENT_MEMBER"
+}
+export interface ListCreateRequestsResponse {
+    /** Create Requests. */
+    createRequests?: CreateRequest[];
+    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 QueryCreateRequestsRequest {
+    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 QueryCreateRequestsResponse {
+    /** Retrieved Create Requests. */
+    createRequests?: CreateRequest[];
+    metadata?: PagingMetadata;
+}

package/build/cjs/src/social-groups-v3-create-request.types.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.OwnershipFilter = exports.ItemsToUpdate = exports.RequestStatus = exports.IdentityType = exports.PrivacyStatus = exports.Type = void 0;
+var Type;
+(function (Type) {
+    Type["UNKNOWN"] = "UNKNOWN";
+    Type["ADMIN_APPROVAL"] = "ADMIN_APPROVAL";
+    Type["PAID_PLANS"] = "PAID_PLANS";
+    Type["EVENTS"] = "EVENTS";
+})(Type = exports.Type || (exports.Type = {}));
+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 = exports.PrivacyStatus || (exports.PrivacyStatus = {}));
+var IdentityType;
+(function (IdentityType) {
+    IdentityType["USER"] = "USER";
+    IdentityType["MEMBER"] = "MEMBER";
+})(IdentityType = exports.IdentityType || (exports.IdentityType = {}));
+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 = exports.RequestStatus || (exports.RequestStatus = {}));
+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 = exports.ItemsToUpdate || (exports.ItemsToUpdate = {}));
+var OwnershipFilter;
+(function (OwnershipFilter) {
+    /** All items. */
+    OwnershipFilter["ALL"] = "ALL";
+    /** Items for current site member. */
+    OwnershipFilter["CURRENT_MEMBER"] = "CURRENT_MEMBER";
+})(OwnershipFilter = exports.OwnershipFilter || (exports.OwnershipFilter = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+//# sourceMappingURL=social-groups-v3-create-request.types.js.map

package/build/cjs/src/social-groups-v3-create-request.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"social-groups-v3-create-request.types.js","sourceRoot":"","sources":["../../../src/social-groups-v3-create-request.types.ts"],"names":[],"mappings":";;;AA+GA,IAAY,IAKX;AALD,WAAY,IAAI;IACd,2BAAmB,CAAA;IACnB,yCAAiC,CAAA;IACjC,iCAAyB,CAAA;IACzB,yBAAiB,CAAA;AACnB,CAAC,EALW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAKf;AAsCD,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,GAAb,qBAAa,KAAb,qBAAa,QAQxB;AAoED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,iCAAiB,CAAA;AACnB,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB;AAED,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,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAsBD,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,gEAAgE;IAChE,gCAAe,CAAA;IACf,wBAAwB;IACxB,wCAAuB,CAAA;AACzB,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB;AAmDD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,iBAAiB;IACjB,8BAAW,CAAA;IACX,qCAAqC;IACrC,oDAAiC,CAAA;AACnC,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B;AAqDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}