@wix/groups 1.0.0

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

@@ -0,0 +1,245 @@
+export interface GroupMember {
+    /**
+     * __Deprecated.__ Use `memberId` instead.
+     * This property will be removed on June 30, 2022.
+     * @readonly
+     */
+    siteMemberId?: string;
+    /**
+     * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
+     * @readonly
+     */
+    memberId?: string;
+    /** Group Member Role. */
+    role?: GroupRole;
+    /**
+     * Date and time the group Member joined the group.
+     * @readonly
+     */
+    joinedDate?: Date;
+}
+/**
+ * A group member may have multiple roles in a single group.
+ * Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
+ */
+export interface GroupRole {
+    /**
+     * Member's role.
+     * - `MEMBER` - Regular group member.
+     * - `ADMIN` - Group administrator.
+     */
+    value?: Role;
+}
+export declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Regular group member. */
+    MEMBER = "MEMBER",
+    /** Group administrator. */
+    ADMIN = "ADMIN"
+}
+/** ID of the group to join. */
+export interface JoinRequest {
+    groupId?: string;
+    /** Answers to membership questions. A Join Request will fail, if the 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 JoinResponse {
+    /** New member. */
+    member?: GroupMember;
+}
+export interface MemberJoined {
+    /** Group ID that member has joined. */
+    groupId?: string;
+    /** Joined group member. */
+    groupMember?: GroupMember;
+}
+export interface LeaveRequest {
+    /** ID of the Group to leave. */
+    groupId?: string;
+}
+export interface LeaveResponse {
+}
+export interface MemberLeft {
+    /** Group ID that member has left. */
+    groupId?: string;
+    /** Group member that left. */
+    groupMember?: GroupMember;
+}
+export interface AddGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+export interface AddGroupMembersResponse {
+    /** New members. */
+    members?: GroupMember[];
+}
+export interface MemberAdded {
+    /** Group ID that member was added to. */
+    groupId?: string;
+    /** Added group member. */
+    groupMember?: GroupMember;
+}
+export interface RemoveGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+export interface RemoveGroupMembersResponse {
+}
+export interface MemberRemoved {
+    /** Group ID that member was removed from. */
+    groupId?: string;
+    /** Removed group member. */
+    groupMember?: GroupMember;
+}
+export interface ListGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /** 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 ListGroupMembersResponse {
+    /** Retrieved members. */
+    members?: GroupMember[];
+    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 QueryGroupMembersRequest {
+    /** 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 QueryGroupMembersResponse {
+    /** Group members. */
+    members?: GroupMember[];
+    metadata?: PagingMetadata;
+}
+export interface QueryNonGroupMembersRequest {
+    /** Group ID. */
+    groupId?: string;
+    query?: Query;
+}
+export interface QueryNonGroupMembersResponse {
+    /** Retrieved members. */
+    members?: GroupMember[];
+}
+export interface ListMembershipsRequest {
+    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberId: string | null;
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListMembershipsResponse {
+    /** Site member's memberships. */
+    memberships?: Membership[];
+    metadata?: PagingMetadata;
+}
+export interface Membership {
+    /**
+     * Group ID.
+     * @readonly
+     */
+    groupId?: string;
+    /**
+     * Membership status with Group
+     * - `JOINED` - Site member is a group member.
+     * - `PENDING` - Site member has submitted a Join Request for this group that is still `PENDING`.
+     */
+    status?: MembershipStatus;
+    /** Group member role. When membership status is not `JOINED`, this is empty. */
+    role?: GroupRole;
+}
+export declare enum MembershipStatus {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Site member is a group member. */
+    JOINED = "JOINED",
+    /** Site member has join group request with `PENDING` status for this group. */
+    PENDING = "PENDING"
+}
+export interface QueryMembershipsRequest {
+    /**
+     * __Deprecated.__ Use the `memberId` path parameter instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberId?: string | null;
+    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberId: string | null;
+    query?: Query;
+}
+export interface QueryMembershipsResponse {
+    /** Site member's memberships. */
+    memberships?: Membership[];
+    metadata?: PagingMetadata;
+}

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MembershipStatus = exports.SortOrder = exports.Role = void 0;
+var Role;
+(function (Role) {
+    Role["UNKNOWN_ROLE"] = "UNKNOWN_ROLE";
+    /** Regular group member. */
+    Role["MEMBER"] = "MEMBER";
+    /** Group administrator. */
+    Role["ADMIN"] = "ADMIN";
+})(Role = exports.Role || (exports.Role = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+var MembershipStatus;
+(function (MembershipStatus) {
+    MembershipStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+    /** Site member is a group member. */
+    MembershipStatus["JOINED"] = "JOINED";
+    /** Site member has join group request with `PENDING` status for this group. */
+    MembershipStatus["PENDING"] = "PENDING";
+})(MembershipStatus = exports.MembershipStatus || (exports.MembershipStatus = {}));
+//# sourceMappingURL=social-groups-v2-group-member.types.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"social-groups-v2-group-member.types.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-member.types.ts"],"names":[],"mappings":";;;AAkCA,IAAY,IAMX;AAND,WAAY,IAAI;IACd,qCAA6B,CAAA;IAC7B,4BAA4B;IAC5B,yBAAiB,CAAA;IACjB,2BAA2B;IAC3B,uBAAe,CAAA;AACjB,CAAC,EANW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAMf;AAuJD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAyDD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,qDAAiC,CAAA;IACjC,qCAAqC;IACrC,qCAAiB,CAAA;IACjB,+EAA+E;IAC/E,uCAAmB,CAAA;AACrB,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B"}

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

@@ -0,0 +1,353 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface GroupMember {
+    /**
+     * __Deprecated.__ Use `memberId` instead.
+     * This property will be removed on June 30, 2022.
+     * @readonly
+     */
+    siteMemberId?: string;
+    /**
+     * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.
+     * @readonly
+     */
+    memberId?: string;
+    /** Group Member Role. */
+    role?: GroupRole;
+    /**
+     * Date and time the group Member joined the group.
+     * @readonly
+     */
+    joinedDate?: Date;
+}
+/**
+ * A group member may have multiple roles in a single group.
+ * Currently, only `MEMBER` and `ADMIN` roles are supported, but more roles may be available in the future.
+ */
+export interface GroupRole {
+    /**
+     * Member's role.
+     * - `MEMBER` - Regular group member.
+     * - `ADMIN` - Group administrator.
+     */
+    value?: Role;
+}
+export declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Regular group member. */
+    MEMBER = "MEMBER",
+    /** Group administrator. */
+    ADMIN = "ADMIN"
+}
+/** ID of the group to join. */
+export interface JoinRequest {
+    groupId?: string;
+    /** Answers to membership questions. A Join Request will fail, if the 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 JoinResponse {
+    /** New member. */
+    member?: GroupMember;
+}
+export interface MemberJoined {
+    /** Group ID that member has joined. */
+    groupId?: string;
+    /** Joined group member. */
+    groupMember?: GroupMember;
+}
+export interface LeaveRequest {
+    /** ID of the Group to leave. */
+    groupId?: string;
+}
+export interface LeaveResponse {
+}
+export interface MemberLeft {
+    /** Group ID that member has left. */
+    groupId?: string;
+    /** Group member that left. */
+    groupMember?: GroupMember;
+}
+export interface AddGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+export interface AddGroupMembersResponse {
+    /** New members. */
+    members?: GroupMember[];
+}
+export interface MemberAdded {
+    /** Group ID that member was added to. */
+    groupId?: string;
+    /** Added group member. */
+    groupMember?: GroupMember;
+}
+export interface RemoveGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+export interface RemoveGroupMembersResponse {
+}
+export interface MemberRemoved {
+    /** Group ID that member was removed from. */
+    groupId?: string;
+    /** Removed group member. */
+    groupMember?: GroupMember;
+}
+export interface ListGroupMembersRequest {
+    /** Group ID. */
+    groupId: string;
+    /** 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 ListGroupMembersResponse {
+    /** Retrieved members. */
+    members?: GroupMember[];
+    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 QueryGroupMembersRequest {
+    /** 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 QueryGroupMembersResponse {
+    /** Group members. */
+    members?: GroupMember[];
+    metadata?: PagingMetadata;
+}
+export interface QueryNonGroupMembersRequest {
+    /** Group ID. */
+    groupId?: string;
+    query?: Query;
+}
+export interface QueryNonGroupMembersResponse {
+    /** Retrieved members. */
+    members?: GroupMember[];
+}
+export interface ListMembershipsRequest {
+    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberId: string | null;
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface ListMembershipsResponse {
+    /** Site member's memberships. */
+    memberships?: Membership[];
+    metadata?: PagingMetadata;
+}
+export interface Membership {
+    /**
+     * Group ID.
+     * @readonly
+     */
+    groupId?: string;
+    /**
+     * Membership status with Group
+     * - `JOINED` - Site member is a group member.
+     * - `PENDING` - Site member has submitted a Join Request for this group that is still `PENDING`.
+     */
+    status?: MembershipStatus;
+    /** Group member role. When membership status is not `JOINED`, this is empty. */
+    role?: GroupRole;
+}
+export declare enum MembershipStatus {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Site member is a group member. */
+    JOINED = "JOINED",
+    /** Site member has join group request with `PENDING` status for this group. */
+    PENDING = "PENDING"
+}
+export interface QueryMembershipsRequest {
+    /**
+     * __Deprecated.__ Use the `memberId` path parameter instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberId?: string | null;
+    /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberId: string | null;
+    query?: Query;
+}
+export interface QueryMembershipsResponse {
+    /** Site member's memberships. */
+    memberships?: Membership[];
+    metadata?: PagingMetadata;
+}
+/**
+ * Add site members to a specific group.
+ * Admins always have access to this functionality. Site owners may allow members to use this functionality as well.
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ */
+export declare function addGroupMembers(groupId: string, options?: AddGroupMembersOptions): Promise<AddGroupMembersResponse>;
+export interface AddGroupMembersOptions {
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+/**
+ * Removes site members from a specific group.
+ * Only admins have can remove members from a group.
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ */
+export declare function removeGroupMembers(groupId: string, options?: RemoveGroupMembersOptions): Promise<void>;
+export interface RemoveGroupMembersOptions {
+    /**
+     * __Deprecated.__ Use `memberIds` instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberIds?: string[];
+    /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */
+    memberIds?: string[];
+}
+/**
+ * Retrieves a list of up to 100 group members, given the provided paging.
+ * Groups mangers can retrieve group members of any group.
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ */
+export declare function listGroupMembers(groupId: string, options?: ListGroupMembersOptions): Promise<ListGroupMembersResponse>;
+export interface ListGroupMembersOptions {
+    /** Number of items to load. Maximum `100.` */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+/**
+ * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.
+ * Groups mangers can retrieve group members of any group.
+ *
+ * Supported fields for filtering:
+ * - `role`
+ *
+ * Supported fields for sorting:
+ * - `joinedOn`
+ * - `role`
+ * @param groupId - Group ID.
+ * @public
+ * @requiredField groupId
+ */
+export declare function queryGroupMembers(groupId: string, options?: QueryGroupMembersOptions): Promise<QueryGroupMembersResponse>;
+export interface QueryGroupMembersOptions {
+    query?: Query;
+}
+/**
+ * Retrieves a list of up to 100 members and their membership status, given the provided paging.
+ * Groups mangers can see all memberships for any group.
+ * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
+ * @public
+ * @requiredField memberId
+ */
+export declare function listMemberships(memberId: string | null, options?: ListMembershipsOptions): Promise<ListMembershipsResponse>;
+export interface ListMembershipsOptions {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+/**
+ * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.
+ * Groups mangers can see all memberships for any group.
+ *
+ * Supported fields for filtering:
+ * - `role`
+ * - `status`
+ *
+ * No supported fields for sorting.
+ * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.
+ * @public
+ * @requiredField memberId
+ */
+export declare function queryMemberships(memberId: string | null, options?: QueryMembershipsOptions): Promise<QueryMembershipsResponse>;
+export interface QueryMembershipsOptions {
+    /**
+     * __Deprecated.__ Use the `memberId` path parameter instead.
+     * This parameter will be removed on June 30, 2022.
+     */
+    siteMemberId?: string | null;
+    query?: Query;
+}