1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/**
* @copyright Copyright (c) 2021 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
import { MemberLevel, MemberType } from '../models/constants';
interface MemberPairs {
id: string;
type: MemberType;
}
declare type CircleEditType = 'name' | 'description' | 'settings' | 'config';
export declare enum CircleEdit {
Name = "name",
Description = "description",
Settings = "settings",
Config = "config"
}
/**
* Get the circles list without the members
*
* @returns {Array}
*/
export declare const getCircles: () => Promise<any>;
/**
* Get a specific circle
* @param {string} circleId
* @returns {Object}
*/
export declare const getCircle: (circleId: string) => Promise<any>;
/**
* Create a new circle
*
* @param {string} name the circle name
* @returns {Object}
*/
export declare const createCircle: (name: string, personal: boolean, local: boolean) => Promise<any>;
/**
* Delete an existing circle
*
* @param {string} circleId the circle id
* @returns {Object}
*/
export declare const deleteCircle: (circleId: string) => Promise<any>;
/**
* Edit an existing circle
*
* @param {string} circleId the circle id
* @param {CircleEditType} type the edit type
* @param {any} data the data
* @returns {Object}
*/
export declare const editCircle: (circleId: string, type: CircleEditType, value: any) => Promise<any>;
/**
* Join a circle
*
* @param {string} circleId the circle id
* @returns {Array}
*/
export declare const joinCircle: (circleId: string) => Promise<any>;
/**
* Leave a circle
*
* @param {string} circleId the circle id
* @returns {Array}
*/
export declare const leaveCircle: (circleId: string) => Promise<any>;
/**
* Get the circle members without the members
*
* @param {string} circleId the circle id
* @returns {Array}
*/
export declare const getCircleMembers: (circleId: string) => Promise<any>;
/**
* Search a potential circle member
*
* @param {string} term the search query
* @returns {Array}
*/
export declare const searchMember: (term: string) => Promise<any>;
/**
* Add a circle member
*
* @param {string} circleId the circle id
* @param {string} members the member id
* @returns {Array}
*/
export declare const addMembers: (circleId: string, members: Array<MemberPairs>) => Promise<any>;
/**
* Delete a circle member
*
* @param {string} circleId the circle id
* @param {string} memberId the member id
* @returns {Array}
*/
export declare const deleteMember: (circleId: string, memberId: string) => Promise<unknown[]>;
/**
* change a member level
* @see levels file src/models/constants.js
*
* @param {string} circleId the circle id
* @param {string} memberId the member id
* @param {number} level the new member level
* @returns {Array}
*/
export declare const changeMemberLevel: (circleId: string, memberId: string, level: MemberLevel) => Promise<unknown[]>;
export {};
|
