@appwrite.io/console 1.5.1 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/cjs/sdk.js +7714 -9758
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +7714 -9758
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +7714 -9758
- package/docs/examples/databases/update-float-attribute.md +2 -2
- package/docs/examples/databases/update-integer-attribute.md +2 -2
- package/docs/examples/health/{get-queue-usage-count.md → get-queue-stats-resources.md} +1 -1
- package/docs/examples/health/{get-queue-usage-dump.md → get-queue-stats-usage-dump.md} +1 -1
- package/docs/examples/organizations/create.md +5 -1
- package/docs/examples/organizations/update-plan.md +5 -1
- package/docs/examples/organizations/validate-invoice.md +14 -0
- package/package.json +1 -1
- package/src/client.ts +21 -4
- package/src/enums/credit-card.ts +1 -0
- package/src/enums/name.ts +3 -2
- package/src/enums/o-auth-provider.ts +1 -0
- package/src/enums/runtime.ts +3 -0
- package/src/models.ts +202 -5
- package/src/services/account.ts +126 -430
- package/src/services/assistant.ts +2 -7
- package/src/services/avatars.ts +7 -21
- package/src/services/backups.ts +24 -84
- package/src/services/console.ts +14 -49
- package/src/services/databases.ts +99 -350
- package/src/services/functions.ts +55 -192
- package/src/services/graphql.ts +4 -14
- package/src/services/health.ts +55 -207
- package/src/services/locale.ts +16 -56
- package/src/services/messaging.ts +92 -322
- package/src/services/migrations.ts +24 -84
- package/src/services/organizations.ts +118 -196
- package/src/services/project.ts +12 -42
- package/src/services/projects.ts +92 -322
- package/src/services/proxy.ts +10 -35
- package/src/services/storage.ts +27 -93
- package/src/services/teams.ts +28 -98
- package/src/services/users.ts +86 -301
- package/src/services/vcs.ts +20 -70
- package/types/enums/credit-card.d.ts +2 -1
- package/types/enums/name.d.ts +3 -2
- package/types/enums/o-auth-provider.d.ts +1 -0
- package/types/enums/runtime.d.ts +3 -0
- package/types/models.d.ts +202 -5
- package/types/services/account.d.ts +4 -128
- package/types/services/assistant.d.ts +0 -2
- package/types/services/avatars.d.ts +0 -14
- package/types/services/backups.d.ts +0 -24
- package/types/services/console.d.ts +0 -14
- package/types/services/databases.d.ts +5 -100
- package/types/services/functions.d.ts +0 -56
- package/types/services/graphql.d.ts +0 -4
- package/types/services/health.d.ts +5 -64
- package/types/services/locale.d.ts +0 -16
- package/types/services/messaging.d.ts +0 -92
- package/types/services/migrations.d.ts +0 -24
- package/types/services/organizations.d.ts +21 -60
- package/types/services/project.d.ts +0 -12
- package/types/services/projects.d.ts +0 -92
- package/types/services/proxy.d.ts +0 -10
- package/types/services/storage.d.ts +0 -30
- package/types/services/teams.d.ts +0 -28
- package/types/services/users.d.ts +0 -86
- package/types/services/vcs.d.ts +0 -20
- package/docs/examples/health/get-queue.md +0 -11
|
@@ -4,8 +4,6 @@ export declare class Teams {
|
|
|
4
4
|
client: Client;
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
|
-
* List teams
|
|
8
|
-
*
|
|
9
7
|
* Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
|
|
10
8
|
*
|
|
11
9
|
* @param {string[]} queries
|
|
@@ -15,8 +13,6 @@ export declare class Teams {
|
|
|
15
13
|
*/
|
|
16
14
|
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
|
|
17
15
|
/**
|
|
18
|
-
* Create team
|
|
19
|
-
*
|
|
20
16
|
* Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
|
|
21
17
|
*
|
|
22
18
|
* @param {string} teamId
|
|
@@ -27,8 +23,6 @@ export declare class Teams {
|
|
|
27
23
|
*/
|
|
28
24
|
create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
|
|
29
25
|
/**
|
|
30
|
-
* Get team
|
|
31
|
-
*
|
|
32
26
|
* Get a team by its ID. All team members have read access for this resource.
|
|
33
27
|
*
|
|
34
28
|
* @param {string} teamId
|
|
@@ -37,8 +31,6 @@ export declare class Teams {
|
|
|
37
31
|
*/
|
|
38
32
|
get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
|
|
39
33
|
/**
|
|
40
|
-
* Update name
|
|
41
|
-
*
|
|
42
34
|
* Update the team's name by its unique ID.
|
|
43
35
|
*
|
|
44
36
|
* @param {string} teamId
|
|
@@ -48,8 +40,6 @@ export declare class Teams {
|
|
|
48
40
|
*/
|
|
49
41
|
updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
|
|
50
42
|
/**
|
|
51
|
-
* Delete team
|
|
52
|
-
*
|
|
53
43
|
* Delete a team using its ID. Only team members with the owner role can delete the team.
|
|
54
44
|
*
|
|
55
45
|
* @param {string} teamId
|
|
@@ -58,8 +48,6 @@ export declare class Teams {
|
|
|
58
48
|
*/
|
|
59
49
|
delete(teamId: string): Promise<{}>;
|
|
60
50
|
/**
|
|
61
|
-
* List team logs
|
|
62
|
-
*
|
|
63
51
|
* Get the team activity logs list by its unique ID.
|
|
64
52
|
*
|
|
65
53
|
* @param {string} teamId
|
|
@@ -69,8 +57,6 @@ export declare class Teams {
|
|
|
69
57
|
*/
|
|
70
58
|
listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
|
|
71
59
|
/**
|
|
72
|
-
* List team memberships
|
|
73
|
-
*
|
|
74
60
|
* Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.
|
|
75
61
|
*
|
|
76
62
|
* @param {string} teamId
|
|
@@ -81,8 +67,6 @@ export declare class Teams {
|
|
|
81
67
|
*/
|
|
82
68
|
listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
|
|
83
69
|
/**
|
|
84
|
-
* Create team membership
|
|
85
|
-
*
|
|
86
70
|
* Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.
|
|
87
71
|
|
|
88
72
|
You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
|
|
@@ -104,8 +88,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
|
|
|
104
88
|
*/
|
|
105
89
|
createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
|
|
106
90
|
/**
|
|
107
|
-
* Get team membership
|
|
108
|
-
*
|
|
109
91
|
* Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
|
|
110
92
|
*
|
|
111
93
|
* @param {string} teamId
|
|
@@ -115,8 +97,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
|
|
|
115
97
|
*/
|
|
116
98
|
getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
|
|
117
99
|
/**
|
|
118
|
-
* Update membership
|
|
119
|
-
*
|
|
120
100
|
* Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
|
|
121
101
|
|
|
122
102
|
*
|
|
@@ -128,8 +108,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
|
|
|
128
108
|
*/
|
|
129
109
|
updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
|
|
130
110
|
/**
|
|
131
|
-
* Delete team membership
|
|
132
|
-
*
|
|
133
111
|
* This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
|
|
134
112
|
*
|
|
135
113
|
* @param {string} teamId
|
|
@@ -139,8 +117,6 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
|
|
|
139
117
|
*/
|
|
140
118
|
deleteMembership(teamId: string, membershipId: string): Promise<{}>;
|
|
141
119
|
/**
|
|
142
|
-
* Update team membership status
|
|
143
|
-
*
|
|
144
120
|
* Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.
|
|
145
121
|
|
|
146
122
|
If the request is successful, a session for the user is automatically created.
|
|
@@ -155,8 +131,6 @@ If the request is successful, a session for the user is automatically created.
|
|
|
155
131
|
*/
|
|
156
132
|
updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
|
|
157
133
|
/**
|
|
158
|
-
* Get team preferences
|
|
159
|
-
*
|
|
160
134
|
* Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
|
|
161
135
|
*
|
|
162
136
|
* @param {string} teamId
|
|
@@ -165,8 +139,6 @@ If the request is successful, a session for the user is automatically created.
|
|
|
165
139
|
*/
|
|
166
140
|
getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
|
|
167
141
|
/**
|
|
168
|
-
* Update preferences
|
|
169
|
-
*
|
|
170
142
|
* Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
|
|
171
143
|
*
|
|
172
144
|
* @param {string} teamId
|
|
@@ -8,8 +8,6 @@ export declare class Users {
|
|
|
8
8
|
client: Client;
|
|
9
9
|
constructor(client: Client);
|
|
10
10
|
/**
|
|
11
|
-
* List users
|
|
12
|
-
*
|
|
13
11
|
* Get a list of all the project's users. You can use the query params to filter your results.
|
|
14
12
|
*
|
|
15
13
|
* @param {string[]} queries
|
|
@@ -19,8 +17,6 @@ export declare class Users {
|
|
|
19
17
|
*/
|
|
20
18
|
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
|
|
21
19
|
/**
|
|
22
|
-
* Create user
|
|
23
|
-
*
|
|
24
20
|
* Create a new user.
|
|
25
21
|
*
|
|
26
22
|
* @param {string} userId
|
|
@@ -33,8 +29,6 @@ export declare class Users {
|
|
|
33
29
|
*/
|
|
34
30
|
create<Preferences extends Models.Preferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
|
|
35
31
|
/**
|
|
36
|
-
* Create user with Argon2 password
|
|
37
|
-
*
|
|
38
32
|
* Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
39
33
|
*
|
|
40
34
|
* @param {string} userId
|
|
@@ -46,8 +40,6 @@ export declare class Users {
|
|
|
46
40
|
*/
|
|
47
41
|
createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
48
42
|
/**
|
|
49
|
-
* Create user with bcrypt password
|
|
50
|
-
*
|
|
51
43
|
* Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
52
44
|
*
|
|
53
45
|
* @param {string} userId
|
|
@@ -59,8 +51,6 @@ export declare class Users {
|
|
|
59
51
|
*/
|
|
60
52
|
createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
61
53
|
/**
|
|
62
|
-
* List identities
|
|
63
|
-
*
|
|
64
54
|
* Get identities for all users.
|
|
65
55
|
*
|
|
66
56
|
* @param {string[]} queries
|
|
@@ -70,8 +60,6 @@ export declare class Users {
|
|
|
70
60
|
*/
|
|
71
61
|
listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
|
|
72
62
|
/**
|
|
73
|
-
* Delete identity
|
|
74
|
-
*
|
|
75
63
|
* Delete an identity by its unique ID.
|
|
76
64
|
*
|
|
77
65
|
* @param {string} identityId
|
|
@@ -80,8 +68,6 @@ export declare class Users {
|
|
|
80
68
|
*/
|
|
81
69
|
deleteIdentity(identityId: string): Promise<{}>;
|
|
82
70
|
/**
|
|
83
|
-
* Create user with MD5 password
|
|
84
|
-
*
|
|
85
71
|
* Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
86
72
|
*
|
|
87
73
|
* @param {string} userId
|
|
@@ -93,8 +79,6 @@ export declare class Users {
|
|
|
93
79
|
*/
|
|
94
80
|
createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
95
81
|
/**
|
|
96
|
-
* Create user with PHPass password
|
|
97
|
-
*
|
|
98
82
|
* Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
99
83
|
*
|
|
100
84
|
* @param {string} userId
|
|
@@ -106,8 +90,6 @@ export declare class Users {
|
|
|
106
90
|
*/
|
|
107
91
|
createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
|
|
108
92
|
/**
|
|
109
|
-
* Create user with Scrypt password
|
|
110
|
-
*
|
|
111
93
|
* Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
112
94
|
*
|
|
113
95
|
* @param {string} userId
|
|
@@ -124,8 +106,6 @@ export declare class Users {
|
|
|
124
106
|
*/
|
|
125
107
|
createScryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
|
|
126
108
|
/**
|
|
127
|
-
* Create user with Scrypt modified password
|
|
128
|
-
*
|
|
129
109
|
* Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
130
110
|
*
|
|
131
111
|
* @param {string} userId
|
|
@@ -140,8 +120,6 @@ export declare class Users {
|
|
|
140
120
|
*/
|
|
141
121
|
createScryptModifiedUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
|
|
142
122
|
/**
|
|
143
|
-
* Create user with SHA password
|
|
144
|
-
*
|
|
145
123
|
* Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
|
|
146
124
|
*
|
|
147
125
|
* @param {string} userId
|
|
@@ -154,8 +132,6 @@ export declare class Users {
|
|
|
154
132
|
*/
|
|
155
133
|
createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
|
|
156
134
|
/**
|
|
157
|
-
* Get users usage stats
|
|
158
|
-
*
|
|
159
135
|
* Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
|
|
160
136
|
|
|
161
137
|
*
|
|
@@ -165,8 +141,6 @@ export declare class Users {
|
|
|
165
141
|
*/
|
|
166
142
|
getUsage(range?: UserUsageRange): Promise<Models.UsageUsers>;
|
|
167
143
|
/**
|
|
168
|
-
* Get user
|
|
169
|
-
*
|
|
170
144
|
* Get a user by its unique ID.
|
|
171
145
|
*
|
|
172
146
|
* @param {string} userId
|
|
@@ -175,8 +149,6 @@ export declare class Users {
|
|
|
175
149
|
*/
|
|
176
150
|
get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
|
|
177
151
|
/**
|
|
178
|
-
* Delete user
|
|
179
|
-
*
|
|
180
152
|
* Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.
|
|
181
153
|
*
|
|
182
154
|
* @param {string} userId
|
|
@@ -185,8 +157,6 @@ export declare class Users {
|
|
|
185
157
|
*/
|
|
186
158
|
delete(userId: string): Promise<{}>;
|
|
187
159
|
/**
|
|
188
|
-
* Update email
|
|
189
|
-
*
|
|
190
160
|
* Update the user email by its unique ID.
|
|
191
161
|
*
|
|
192
162
|
* @param {string} userId
|
|
@@ -196,8 +166,6 @@ export declare class Users {
|
|
|
196
166
|
*/
|
|
197
167
|
updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
|
|
198
168
|
/**
|
|
199
|
-
* Create user JWT
|
|
200
|
-
*
|
|
201
169
|
* Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
|
|
202
170
|
*
|
|
203
171
|
* @param {string} userId
|
|
@@ -208,8 +176,6 @@ export declare class Users {
|
|
|
208
176
|
*/
|
|
209
177
|
createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
|
|
210
178
|
/**
|
|
211
|
-
* Update user labels
|
|
212
|
-
*
|
|
213
179
|
* Update the user labels by its unique ID.
|
|
214
180
|
|
|
215
181
|
Labels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
|
|
@@ -221,8 +187,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
221
187
|
*/
|
|
222
188
|
updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
|
|
223
189
|
/**
|
|
224
|
-
* List user logs
|
|
225
|
-
*
|
|
226
190
|
* Get the user activity logs list by its unique ID.
|
|
227
191
|
*
|
|
228
192
|
* @param {string} userId
|
|
@@ -232,8 +196,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
232
196
|
*/
|
|
233
197
|
listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
|
|
234
198
|
/**
|
|
235
|
-
* List user memberships
|
|
236
|
-
*
|
|
237
199
|
* Get the user membership list by its unique ID.
|
|
238
200
|
*
|
|
239
201
|
* @param {string} userId
|
|
@@ -242,8 +204,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
242
204
|
*/
|
|
243
205
|
listMemberships(userId: string): Promise<Models.MembershipList>;
|
|
244
206
|
/**
|
|
245
|
-
* Update MFA
|
|
246
|
-
*
|
|
247
207
|
* Enable or disable MFA on a user account.
|
|
248
208
|
*
|
|
249
209
|
* @param {string} userId
|
|
@@ -253,8 +213,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
253
213
|
*/
|
|
254
214
|
updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
|
|
255
215
|
/**
|
|
256
|
-
* Delete authenticator
|
|
257
|
-
*
|
|
258
216
|
* Delete an authenticator app.
|
|
259
217
|
*
|
|
260
218
|
* @param {string} userId
|
|
@@ -264,8 +222,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
264
222
|
*/
|
|
265
223
|
deleteMfaAuthenticator(userId: string, type: AuthenticatorType): Promise<{}>;
|
|
266
224
|
/**
|
|
267
|
-
* List factors
|
|
268
|
-
*
|
|
269
225
|
* List the factors available on the account to be used as a MFA challange.
|
|
270
226
|
*
|
|
271
227
|
* @param {string} userId
|
|
@@ -274,8 +230,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
274
230
|
*/
|
|
275
231
|
listMfaFactors(userId: string): Promise<Models.MfaFactors>;
|
|
276
232
|
/**
|
|
277
|
-
* Get MFA recovery codes
|
|
278
|
-
*
|
|
279
233
|
* Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
280
234
|
*
|
|
281
235
|
* @param {string} userId
|
|
@@ -284,8 +238,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
284
238
|
*/
|
|
285
239
|
getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
286
240
|
/**
|
|
287
|
-
* Regenerate MFA recovery codes
|
|
288
|
-
*
|
|
289
241
|
* Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
|
|
290
242
|
*
|
|
291
243
|
* @param {string} userId
|
|
@@ -294,8 +246,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
294
246
|
*/
|
|
295
247
|
updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
296
248
|
/**
|
|
297
|
-
* Create MFA recovery codes
|
|
298
|
-
*
|
|
299
249
|
* Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
|
|
300
250
|
*
|
|
301
251
|
* @param {string} userId
|
|
@@ -304,8 +254,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
304
254
|
*/
|
|
305
255
|
createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
|
|
306
256
|
/**
|
|
307
|
-
* Update name
|
|
308
|
-
*
|
|
309
257
|
* Update the user name by its unique ID.
|
|
310
258
|
*
|
|
311
259
|
* @param {string} userId
|
|
@@ -315,8 +263,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
315
263
|
*/
|
|
316
264
|
updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
|
|
317
265
|
/**
|
|
318
|
-
* Update password
|
|
319
|
-
*
|
|
320
266
|
* Update the user password by its unique ID.
|
|
321
267
|
*
|
|
322
268
|
* @param {string} userId
|
|
@@ -326,8 +272,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
326
272
|
*/
|
|
327
273
|
updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
|
|
328
274
|
/**
|
|
329
|
-
* Update phone
|
|
330
|
-
*
|
|
331
275
|
* Update the user phone by its unique ID.
|
|
332
276
|
*
|
|
333
277
|
* @param {string} userId
|
|
@@ -337,8 +281,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
337
281
|
*/
|
|
338
282
|
updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
|
|
339
283
|
/**
|
|
340
|
-
* Get user preferences
|
|
341
|
-
*
|
|
342
284
|
* Get the user preferences by its unique ID.
|
|
343
285
|
*
|
|
344
286
|
* @param {string} userId
|
|
@@ -347,8 +289,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
347
289
|
*/
|
|
348
290
|
getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
|
|
349
291
|
/**
|
|
350
|
-
* Update user preferences
|
|
351
|
-
*
|
|
352
292
|
* Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
|
|
353
293
|
*
|
|
354
294
|
* @param {string} userId
|
|
@@ -358,8 +298,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
358
298
|
*/
|
|
359
299
|
updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
|
|
360
300
|
/**
|
|
361
|
-
* List user sessions
|
|
362
|
-
*
|
|
363
301
|
* Get the user sessions list by its unique ID.
|
|
364
302
|
*
|
|
365
303
|
* @param {string} userId
|
|
@@ -368,8 +306,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
|
|
|
368
306
|
*/
|
|
369
307
|
listSessions(userId: string): Promise<Models.SessionList>;
|
|
370
308
|
/**
|
|
371
|
-
* Create session
|
|
372
|
-
*
|
|
373
309
|
* Creates a session for a user. Returns an immediately usable session object.
|
|
374
310
|
|
|
375
311
|
If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
|
|
@@ -380,8 +316,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
380
316
|
*/
|
|
381
317
|
createSession(userId: string): Promise<Models.Session>;
|
|
382
318
|
/**
|
|
383
|
-
* Delete user sessions
|
|
384
|
-
*
|
|
385
319
|
* Delete all user's sessions by using the user's unique ID.
|
|
386
320
|
*
|
|
387
321
|
* @param {string} userId
|
|
@@ -390,8 +324,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
390
324
|
*/
|
|
391
325
|
deleteSessions(userId: string): Promise<{}>;
|
|
392
326
|
/**
|
|
393
|
-
* Delete user session
|
|
394
|
-
*
|
|
395
327
|
* Delete a user sessions by its unique ID.
|
|
396
328
|
*
|
|
397
329
|
* @param {string} userId
|
|
@@ -401,8 +333,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
401
333
|
*/
|
|
402
334
|
deleteSession(userId: string, sessionId: string): Promise<{}>;
|
|
403
335
|
/**
|
|
404
|
-
* Update user status
|
|
405
|
-
*
|
|
406
336
|
* Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.
|
|
407
337
|
*
|
|
408
338
|
* @param {string} userId
|
|
@@ -412,8 +342,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
412
342
|
*/
|
|
413
343
|
updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
|
|
414
344
|
/**
|
|
415
|
-
* List user targets
|
|
416
|
-
*
|
|
417
345
|
* List the messaging targets that are associated with a user.
|
|
418
346
|
*
|
|
419
347
|
* @param {string} userId
|
|
@@ -423,8 +351,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
423
351
|
*/
|
|
424
352
|
listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
|
|
425
353
|
/**
|
|
426
|
-
* Create user target
|
|
427
|
-
*
|
|
428
354
|
* Create a messaging target.
|
|
429
355
|
*
|
|
430
356
|
* @param {string} userId
|
|
@@ -438,8 +364,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
438
364
|
*/
|
|
439
365
|
createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
|
|
440
366
|
/**
|
|
441
|
-
* Get user target
|
|
442
|
-
*
|
|
443
367
|
* Get a user's push notification target by ID.
|
|
444
368
|
*
|
|
445
369
|
* @param {string} userId
|
|
@@ -449,8 +373,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
449
373
|
*/
|
|
450
374
|
getTarget(userId: string, targetId: string): Promise<Models.Target>;
|
|
451
375
|
/**
|
|
452
|
-
* Update user target
|
|
453
|
-
*
|
|
454
376
|
* Update a messaging target.
|
|
455
377
|
*
|
|
456
378
|
* @param {string} userId
|
|
@@ -463,8 +385,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
463
385
|
*/
|
|
464
386
|
updateTarget(userId: string, targetId: string, identifier?: string, providerId?: string, name?: string): Promise<Models.Target>;
|
|
465
387
|
/**
|
|
466
|
-
* Delete user target
|
|
467
|
-
*
|
|
468
388
|
* Delete a messaging target.
|
|
469
389
|
*
|
|
470
390
|
* @param {string} userId
|
|
@@ -474,8 +394,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
474
394
|
*/
|
|
475
395
|
deleteTarget(userId: string, targetId: string): Promise<{}>;
|
|
476
396
|
/**
|
|
477
|
-
* Create token
|
|
478
|
-
*
|
|
479
397
|
* Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
|
|
480
398
|
|
|
481
399
|
*
|
|
@@ -487,8 +405,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
487
405
|
*/
|
|
488
406
|
createToken(userId: string, length?: number, expire?: number): Promise<Models.Token>;
|
|
489
407
|
/**
|
|
490
|
-
* Update email verification
|
|
491
|
-
*
|
|
492
408
|
* Update the user email verification status by its unique ID.
|
|
493
409
|
*
|
|
494
410
|
* @param {string} userId
|
|
@@ -498,8 +414,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
|
|
|
498
414
|
*/
|
|
499
415
|
updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
|
|
500
416
|
/**
|
|
501
|
-
* Update phone verification
|
|
502
|
-
*
|
|
503
417
|
* Update the user phone verification status by its unique ID.
|
|
504
418
|
*
|
|
505
419
|
* @param {string} userId
|
package/types/services/vcs.d.ts
CHANGED
|
@@ -4,8 +4,6 @@ export declare class Vcs {
|
|
|
4
4
|
client: Client;
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
|
-
* List repositories
|
|
8
|
-
*
|
|
9
7
|
* Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
|
|
10
8
|
*
|
|
11
9
|
* @param {string} installationId
|
|
@@ -15,8 +13,6 @@ export declare class Vcs {
|
|
|
15
13
|
*/
|
|
16
14
|
listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList>;
|
|
17
15
|
/**
|
|
18
|
-
* Create repository
|
|
19
|
-
*
|
|
20
16
|
* Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
|
|
21
17
|
*
|
|
22
18
|
* @param {string} installationId
|
|
@@ -27,8 +23,6 @@ export declare class Vcs {
|
|
|
27
23
|
*/
|
|
28
24
|
createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository>;
|
|
29
25
|
/**
|
|
30
|
-
* Get repository
|
|
31
|
-
*
|
|
32
26
|
* Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
33
27
|
*
|
|
34
28
|
* @param {string} installationId
|
|
@@ -38,8 +32,6 @@ export declare class Vcs {
|
|
|
38
32
|
*/
|
|
39
33
|
getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository>;
|
|
40
34
|
/**
|
|
41
|
-
* List repository branches
|
|
42
|
-
*
|
|
43
35
|
* Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
|
|
44
36
|
|
|
45
37
|
*
|
|
@@ -50,8 +42,6 @@ export declare class Vcs {
|
|
|
50
42
|
*/
|
|
51
43
|
listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
|
|
52
44
|
/**
|
|
53
|
-
* Get files and directories of a VCS repository
|
|
54
|
-
*
|
|
55
45
|
* Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
56
46
|
|
|
57
47
|
*
|
|
@@ -63,8 +53,6 @@ export declare class Vcs {
|
|
|
63
53
|
*/
|
|
64
54
|
getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList>;
|
|
65
55
|
/**
|
|
66
|
-
* Detect runtime settings from source code
|
|
67
|
-
*
|
|
68
56
|
* Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
|
|
69
57
|
*
|
|
70
58
|
* @param {string} installationId
|
|
@@ -75,8 +63,6 @@ export declare class Vcs {
|
|
|
75
63
|
*/
|
|
76
64
|
createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection>;
|
|
77
65
|
/**
|
|
78
|
-
* Authorize external deployment
|
|
79
|
-
*
|
|
80
66
|
* Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
|
|
81
67
|
*
|
|
82
68
|
* @param {string} installationId
|
|
@@ -87,8 +73,6 @@ export declare class Vcs {
|
|
|
87
73
|
*/
|
|
88
74
|
updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}>;
|
|
89
75
|
/**
|
|
90
|
-
* List installations
|
|
91
|
-
*
|
|
92
76
|
* List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
|
|
93
77
|
|
|
94
78
|
*
|
|
@@ -99,8 +83,6 @@ export declare class Vcs {
|
|
|
99
83
|
*/
|
|
100
84
|
listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList>;
|
|
101
85
|
/**
|
|
102
|
-
* Get installation
|
|
103
|
-
*
|
|
104
86
|
* Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration.
|
|
105
87
|
*
|
|
106
88
|
* @param {string} installationId
|
|
@@ -109,8 +91,6 @@ export declare class Vcs {
|
|
|
109
91
|
*/
|
|
110
92
|
getInstallation(installationId: string): Promise<Models.Installation>;
|
|
111
93
|
/**
|
|
112
|
-
* Delete installation
|
|
113
|
-
*
|
|
114
94
|
* Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
|
|
115
95
|
*
|
|
116
96
|
* @param {string} installationId
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { Client, Health } from "@appwrite.io/console";
|
|
2
|
-
|
|
3
|
-
const client = new Client()
|
|
4
|
-
.setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
|
|
5
|
-
.setProject('<YOUR_PROJECT_ID>'); // Your project ID
|
|
6
|
-
|
|
7
|
-
const health = new Health(client);
|
|
8
|
-
|
|
9
|
-
const result = await health.getQueue();
|
|
10
|
-
|
|
11
|
-
console.log(result);
|