/** * To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin. * When the request is approved, the site member becomes a group member. */ interface JoinRequest$1 { /** * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. * @readonly */ memberId?: string; /** * Join request status. * - `PENDING` - Pending join request. * - `APPROVED` - Approved join request. * - `REJECTED` - Rejected join request. * - `CANCELED` - Canceled join request. */ status?: RequestStatus$1; /** Join request details. */ requestDetails?: RequestDetails$1; } declare enum RequestStatus$1 { /** Undefined request status. */ UNKNOWN_STATUS = "UNKNOWN_STATUS", /** Pending group request. */ PENDING = "PENDING", /** Approved group request. */ APPROVED = "APPROVED", /** Rejected group request. */ REJECTED = "REJECTED", /** Cancelled group request. */ CANCELLED = "CANCELLED", /** Canceled group request. */ CANCELED = "CANCELED" } interface RequestDetails$1 { /** Reason the request has been rejected. */ rejectionReason?: string | null; } interface ApproveJoinRequestsRequest$1 { /** Relevant group. */ groupId: string; /** Member IDs to approve. */ memberIds: string[]; } interface ApproveJoinRequestsResponse$1 { /** Approved join requests. */ joinRequests?: JoinRequest$1[]; } interface RejectJoinRequestsRequest$1 { /** Relevant group. */ groupId: string; /** Rejection data. */ rejections?: Rejection$1[]; } interface Rejection$1 { /** Member ID to reject. */ memberId?: string; /** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */ reason?: string | null; } interface RejectJoinRequestsResponse$1 { /** Rejected join requests. */ joinRequests?: JoinRequest$1[]; } interface ListJoinRequestsRequest$1 { /** Group ID. */ groupId: string; limit?: number | null; offset?: number | null; } interface ListJoinRequestsResponse$1 { /** Join requests. */ joinRequests?: JoinRequest$1[]; metadata?: PagingMetadata$1; } interface PagingMetadata$1 { /** 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; } interface QueryJoinRequestsRequest$1 { /** Group ID. */ groupId: string; query?: Query$1; } interface Query$1 { /** * 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$1[]; /** Paging options to limit and skip the number of items. */ paging?: Paging$1; /** 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[]; } interface Sorting$1 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$1; } declare enum SortOrder$1 { ASC = "ASC", DESC = "DESC" } interface Paging$1 { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface QueryJoinRequestsResponse$1 { /** Join requests. */ joinRequests?: JoinRequest$1[]; metadata?: PagingMetadata$1; } interface JoinRequestNonNullableFields$1 { memberId: string; status: RequestStatus$1; } interface ApproveJoinRequestsResponseNonNullableFields$1 { joinRequests: JoinRequestNonNullableFields$1[]; } interface RejectJoinRequestsResponseNonNullableFields$1 { joinRequests: JoinRequestNonNullableFields$1[]; } interface ListJoinRequestsResponseNonNullableFields$1 { joinRequests: JoinRequestNonNullableFields$1[]; } interface QueryJoinRequestsResponseNonNullableFields$1 { joinRequests: JoinRequestNonNullableFields$1[]; } /** * To join a private group, a site member must submit a Join Request, which can be approved or rejected by an admin. * When the request is approved, the site member becomes a group member. */ interface JoinRequest { /** * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. * @readonly */ memberId?: string; /** * Join request status. * - `PENDING` - Pending join request. * - `APPROVED` - Approved join request. * - `REJECTED` - Rejected join request. * - `CANCELED` - Canceled join request. */ status?: RequestStatus; /** Join request details. */ requestDetails?: RequestDetails; } declare enum RequestStatus { /** Undefined request status. */ UNKNOWN_STATUS = "UNKNOWN_STATUS", /** Pending group request. */ PENDING = "PENDING", /** Approved group request. */ APPROVED = "APPROVED", /** Rejected group request. */ REJECTED = "REJECTED", /** Cancelled group request. */ CANCELLED = "CANCELLED", /** Canceled group request. */ CANCELED = "CANCELED" } interface RequestDetails { /** Reason the request has been rejected. */ rejectionReason?: string | null; } interface ApproveJoinRequestsRequest { /** Relevant group. */ groupId: string; /** Member IDs to approve. */ memberIds: string[]; } interface ApproveJoinRequestsResponse { /** Approved join requests. */ joinRequests?: JoinRequest[]; } interface RejectJoinRequestsRequest { /** Relevant group. */ groupId: string; /** Rejection data. */ rejections?: Rejection[]; } interface Rejection { /** Member ID to reject. */ memberId?: string; /** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */ reason?: string | null; } interface RejectJoinRequestsResponse { /** Rejected join requests. */ joinRequests?: JoinRequest[]; } interface ListJoinRequestsRequest { /** Group ID. */ groupId: string; limit?: number | null; offset?: number | null; } interface ListJoinRequestsResponse { /** Join requests. */ joinRequests?: JoinRequest[]; metadata?: PagingMetadata; } 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; } interface QueryJoinRequestsRequest { /** Group ID. */ groupId: string; query?: Query; } 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[]; } interface Sorting { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } interface Paging { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface QueryJoinRequestsResponse { /** Join requests. */ joinRequests?: JoinRequest[]; metadata?: PagingMetadata; } interface JoinRequestNonNullableFields { memberId: string; status: RequestStatus; } interface ApproveJoinRequestsResponseNonNullableFields { joinRequests: JoinRequestNonNullableFields[]; } interface RejectJoinRequestsResponseNonNullableFields { joinRequests: JoinRequestNonNullableFields[]; } interface ListJoinRequestsResponseNonNullableFields { joinRequests: JoinRequestNonNullableFields[]; } interface QueryJoinRequestsResponseNonNullableFields { joinRequests: JoinRequestNonNullableFields[]; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function approveJoinRequests(): __PublicMethodMetaInfo<'POST', { groupId: string; }, ApproveJoinRequestsRequest, ApproveJoinRequestsRequest$1, ApproveJoinRequestsResponse & ApproveJoinRequestsResponseNonNullableFields, ApproveJoinRequestsResponse$1 & ApproveJoinRequestsResponseNonNullableFields$1>; declare function rejectJoinRequests(): __PublicMethodMetaInfo<'POST', { groupId: string; }, RejectJoinRequestsRequest, RejectJoinRequestsRequest$1, RejectJoinRequestsResponse & RejectJoinRequestsResponseNonNullableFields, RejectJoinRequestsResponse$1 & RejectJoinRequestsResponseNonNullableFields$1>; declare function listJoinRequests(): __PublicMethodMetaInfo<'GET', { groupId: string; }, ListJoinRequestsRequest, ListJoinRequestsRequest$1, ListJoinRequestsResponse & ListJoinRequestsResponseNonNullableFields, ListJoinRequestsResponse$1 & ListJoinRequestsResponseNonNullableFields$1>; declare function queryJoinRequests(): __PublicMethodMetaInfo<'POST', { groupId: string; }, QueryJoinRequestsRequest, QueryJoinRequestsRequest$1, QueryJoinRequestsResponse & QueryJoinRequestsResponseNonNullableFields, QueryJoinRequestsResponse$1 & QueryJoinRequestsResponseNonNullableFields$1>; export { type __PublicMethodMetaInfo, approveJoinRequests, listJoinRequests, queryJoinRequests, rejectJoinRequests };