@appwrite.io/console 15.4.0 → 15.5.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 +1 -1
- package/dist/cjs/sdk.js +502 -48
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +502 -48
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +502 -48
- package/package.json +1 -1
- package/types/enums/organization-key-scopes.d.ts +2 -0
- package/types/enums/query-suggestion-resource.d.ts +2 -1
- package/types/models.d.ts +124 -0
- package/types/services/apps.d.ts +102 -1
- package/types/services/organization.d.ts +104 -0
- package/types/services/project.d.ts +4 -1
- package/types/services/projects.d.ts +0 -25
- package/types/services/teams.d.ts +119 -0
- package/types/services/vectors-db.d.ts +36 -0
package/types/models.d.ts
CHANGED
|
@@ -5145,6 +5145,10 @@ export declare namespace Models {
|
|
|
5145
5145
|
* OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)
|
|
5146
5146
|
*/
|
|
5147
5147
|
oAuth2ServerPublicRefreshTokenDuration?: number;
|
|
5148
|
+
/**
|
|
5149
|
+
* OAuth2 server access token duration in seconds for app installation access tokens
|
|
5150
|
+
*/
|
|
5151
|
+
oAuth2ServerInstallationAccessTokenDuration?: number;
|
|
5148
5152
|
/**
|
|
5149
5153
|
* When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
|
|
5150
5154
|
*/
|
|
@@ -11923,6 +11927,14 @@ export declare namespace Models {
|
|
|
11923
11927
|
* ID of user who owns the application, if owned by user. Otherwise, team ID will be used.
|
|
11924
11928
|
*/
|
|
11925
11929
|
userId: string;
|
|
11930
|
+
/**
|
|
11931
|
+
* Scopes the application requests when installed on a team. Organization-level and project-level scopes only.
|
|
11932
|
+
*/
|
|
11933
|
+
installationScopes: string[];
|
|
11934
|
+
/**
|
|
11935
|
+
* URL users are redirected to after creating or updating an installation of this application. Empty for no redirect.
|
|
11936
|
+
*/
|
|
11937
|
+
installationRedirectUrl: string;
|
|
11926
11938
|
/**
|
|
11927
11939
|
* List of application secrets.
|
|
11928
11940
|
*/
|
|
@@ -12035,6 +12047,92 @@ export declare namespace Models {
|
|
|
12035
12047
|
*/
|
|
12036
12048
|
deprecated: boolean;
|
|
12037
12049
|
};
|
|
12050
|
+
/**
|
|
12051
|
+
* AppInstallation
|
|
12052
|
+
*/
|
|
12053
|
+
export type AppInstallation = {
|
|
12054
|
+
/**
|
|
12055
|
+
* Installation ID.
|
|
12056
|
+
*/
|
|
12057
|
+
$id: string;
|
|
12058
|
+
/**
|
|
12059
|
+
* Installation creation time in ISO 8601 format.
|
|
12060
|
+
*/
|
|
12061
|
+
$createdAt: string;
|
|
12062
|
+
/**
|
|
12063
|
+
* Installation update time in ISO 8601 format.
|
|
12064
|
+
*/
|
|
12065
|
+
$updatedAt: string;
|
|
12066
|
+
/**
|
|
12067
|
+
* ID of the installed application.
|
|
12068
|
+
*/
|
|
12069
|
+
appId: string;
|
|
12070
|
+
/**
|
|
12071
|
+
* ID of the team the application is installed on.
|
|
12072
|
+
*/
|
|
12073
|
+
teamId: string;
|
|
12074
|
+
/**
|
|
12075
|
+
* Scopes granted to the application. Snapshot of the application's installation scopes taken when the installation was created or last updated.
|
|
12076
|
+
*/
|
|
12077
|
+
scopes: string[];
|
|
12078
|
+
/**
|
|
12079
|
+
* Authorization details granted to the application. Rich authorization request (RFC 9396) style entries; the Appwrite Console stores authorized project IDs here.
|
|
12080
|
+
*/
|
|
12081
|
+
authorizationDetails: object;
|
|
12082
|
+
/**
|
|
12083
|
+
* ID of the user who created the installation.
|
|
12084
|
+
*/
|
|
12085
|
+
createdById: string;
|
|
12086
|
+
/**
|
|
12087
|
+
* Name of the user who created the installation.
|
|
12088
|
+
*/
|
|
12089
|
+
createdByName: string;
|
|
12090
|
+
/**
|
|
12091
|
+
* Time an access token was last issued for the installation in ISO 8601 format. Null if never used.
|
|
12092
|
+
*/
|
|
12093
|
+
lastAccessedAt?: string;
|
|
12094
|
+
};
|
|
12095
|
+
/**
|
|
12096
|
+
* AppKey
|
|
12097
|
+
*/
|
|
12098
|
+
export type AppKey = {
|
|
12099
|
+
/**
|
|
12100
|
+
* App key ID.
|
|
12101
|
+
*/
|
|
12102
|
+
$id: string;
|
|
12103
|
+
/**
|
|
12104
|
+
* App key creation time in ISO 8601 format.
|
|
12105
|
+
*/
|
|
12106
|
+
$createdAt: string;
|
|
12107
|
+
/**
|
|
12108
|
+
* App key update time in ISO 8601 format.
|
|
12109
|
+
*/
|
|
12110
|
+
$updatedAt: string;
|
|
12111
|
+
/**
|
|
12112
|
+
* Application ID this app key belongs to.
|
|
12113
|
+
*/
|
|
12114
|
+
appId: string;
|
|
12115
|
+
/**
|
|
12116
|
+
* App key secret.
|
|
12117
|
+
*/
|
|
12118
|
+
secret: string;
|
|
12119
|
+
/**
|
|
12120
|
+
* Last few characters of the app key secret, used to help identify it.
|
|
12121
|
+
*/
|
|
12122
|
+
hint: string;
|
|
12123
|
+
/**
|
|
12124
|
+
* ID of the user who created the app key.
|
|
12125
|
+
*/
|
|
12126
|
+
createdById: string;
|
|
12127
|
+
/**
|
|
12128
|
+
* Name of the user who created the app key.
|
|
12129
|
+
*/
|
|
12130
|
+
createdByName: string;
|
|
12131
|
+
/**
|
|
12132
|
+
* Time the app key was last used for authentication in ISO 8601 format. Null if never used.
|
|
12133
|
+
*/
|
|
12134
|
+
lastAccessedAt?: string;
|
|
12135
|
+
};
|
|
12038
12136
|
/**
|
|
12039
12137
|
* OAuth2 Authorize
|
|
12040
12138
|
*/
|
|
@@ -12986,5 +13084,31 @@ export declare namespace Models {
|
|
|
12986
13084
|
*/
|
|
12987
13085
|
scopes: AppScope[];
|
|
12988
13086
|
};
|
|
13087
|
+
/**
|
|
13088
|
+
* App installations list
|
|
13089
|
+
*/
|
|
13090
|
+
export type AppInstallationList = {
|
|
13091
|
+
/**
|
|
13092
|
+
* Total number of installations that matched your query.
|
|
13093
|
+
*/
|
|
13094
|
+
total: number;
|
|
13095
|
+
/**
|
|
13096
|
+
* List of installations.
|
|
13097
|
+
*/
|
|
13098
|
+
installations: AppInstallation[];
|
|
13099
|
+
};
|
|
13100
|
+
/**
|
|
13101
|
+
* App keys list
|
|
13102
|
+
*/
|
|
13103
|
+
export type AppKeyList = {
|
|
13104
|
+
/**
|
|
13105
|
+
* Total number of keys that matched your query.
|
|
13106
|
+
*/
|
|
13107
|
+
total: number;
|
|
13108
|
+
/**
|
|
13109
|
+
* List of keys.
|
|
13110
|
+
*/
|
|
13111
|
+
keys: AppKey[];
|
|
13112
|
+
};
|
|
12989
13113
|
export {};
|
|
12990
13114
|
}
|
package/types/services/apps.d.ts
CHANGED
|
@@ -98,6 +98,13 @@ export declare class Apps {
|
|
|
98
98
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
99
|
*/
|
|
100
100
|
create(appId: string, name: string, redirectUris: string[], description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], tagline?: string, tags?: string[], images?: string[], supportUrl?: string, dataDeletionUrl?: string, postLogoutRedirectUris?: string[], enabled?: boolean, type?: string, deviceFlow?: boolean, teamId?: string): Promise<Models.App>;
|
|
101
|
+
/**
|
|
102
|
+
* List scopes an application can request when installed on a team.
|
|
103
|
+
*
|
|
104
|
+
* @throws {AppwriteException}
|
|
105
|
+
* @returns {Promise<Models.AppScopeList>}
|
|
106
|
+
*/
|
|
107
|
+
listInstallationScopes(): Promise<Models.AppScopeList>;
|
|
101
108
|
/**
|
|
102
109
|
* List scopes an application can request during the OAuth2 flow.
|
|
103
110
|
*
|
|
@@ -145,6 +152,8 @@ export declare class Apps {
|
|
|
145
152
|
* @param {string[]} params.postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
146
153
|
* @param {string} params.type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
|
|
147
154
|
* @param {boolean} params.deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
|
|
155
|
+
* @param {string[]} params.installationScopes - Scopes the application requests when installed on a team. Organization-level and project-level scopes only; use the list scopes endpoint with `type=installation` to discover available values. Maximum of 100 scopes are allowed.
|
|
156
|
+
* @param {string} params.installationRedirectUrl - URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.
|
|
148
157
|
* @throws {AppwriteException}
|
|
149
158
|
* @returns {Promise<Models.App>}
|
|
150
159
|
*/
|
|
@@ -167,6 +176,8 @@ export declare class Apps {
|
|
|
167
176
|
postLogoutRedirectUris?: string[];
|
|
168
177
|
type?: string;
|
|
169
178
|
deviceFlow?: boolean;
|
|
179
|
+
installationScopes?: string[];
|
|
180
|
+
installationRedirectUrl?: string;
|
|
170
181
|
}): Promise<Models.App>;
|
|
171
182
|
/**
|
|
172
183
|
* Update an application by its unique ID.
|
|
@@ -189,11 +200,13 @@ export declare class Apps {
|
|
|
189
200
|
* @param {string[]} postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout. Each must be an https URL, an http loopback URL, or a private-use scheme URI, and must not contain a fragment. After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
190
201
|
* @param {string} type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
|
|
191
202
|
* @param {boolean} deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
|
|
203
|
+
* @param {string[]} installationScopes - Scopes the application requests when installed on a team. Organization-level and project-level scopes only; use the list scopes endpoint with `type=installation` to discover available values. Maximum of 100 scopes are allowed.
|
|
204
|
+
* @param {string} installationRedirectUrl - URL users are redirected to after creating or updating an installation of this application. Must be an https URL, an http loopback URL (localhost, 127.0.0.1, [::1]), or a private-use scheme URI, and must not contain a fragment. Leave empty for no redirect.
|
|
192
205
|
* @throws {AppwriteException}
|
|
193
206
|
* @returns {Promise<Models.App>}
|
|
194
207
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
208
|
*/
|
|
196
|
-
update(appId: string, name: string, description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], tagline?: string, tags?: string[], images?: string[], supportUrl?: string, dataDeletionUrl?: string, enabled?: boolean, redirectUris?: string[], postLogoutRedirectUris?: string[], type?: string, deviceFlow?: boolean): Promise<Models.App>;
|
|
209
|
+
update(appId: string, name: string, description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], tagline?: string, tags?: string[], images?: string[], supportUrl?: string, dataDeletionUrl?: string, enabled?: boolean, redirectUris?: string[], postLogoutRedirectUris?: string[], type?: string, deviceFlow?: boolean, installationScopes?: string[], installationRedirectUrl?: string): Promise<Models.App>;
|
|
197
210
|
/**
|
|
198
211
|
* Delete an application by its unique ID.
|
|
199
212
|
*
|
|
@@ -213,6 +226,94 @@ export declare class Apps {
|
|
|
213
226
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
214
227
|
*/
|
|
215
228
|
delete(appId: string): Promise<{}>;
|
|
229
|
+
/**
|
|
230
|
+
* List app keys for an application.
|
|
231
|
+
*
|
|
232
|
+
* @param {string} params.appId - Application unique ID.
|
|
233
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
234
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
235
|
+
* @throws {AppwriteException}
|
|
236
|
+
* @returns {Promise<Models.AppKeyList>}
|
|
237
|
+
*/
|
|
238
|
+
listKeys(params: {
|
|
239
|
+
appId: string;
|
|
240
|
+
queries?: string[];
|
|
241
|
+
total?: boolean;
|
|
242
|
+
}): Promise<Models.AppKeyList>;
|
|
243
|
+
/**
|
|
244
|
+
* List app keys for an application.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} appId - Application unique ID.
|
|
247
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
248
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
249
|
+
* @throws {AppwriteException}
|
|
250
|
+
* @returns {Promise<Models.AppKeyList>}
|
|
251
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
252
|
+
*/
|
|
253
|
+
listKeys(appId: string, queries?: string[], total?: boolean): Promise<Models.AppKeyList>;
|
|
254
|
+
/**
|
|
255
|
+
* Create a new app key for an application. App keys carry no scopes; send one in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header to list the application's installations and create installation access tokens.
|
|
256
|
+
*
|
|
257
|
+
* @param {string} params.appId - Application unique ID.
|
|
258
|
+
* @throws {AppwriteException}
|
|
259
|
+
* @returns {Promise<Models.AppKey>}
|
|
260
|
+
*/
|
|
261
|
+
createKey(params: {
|
|
262
|
+
appId: string;
|
|
263
|
+
}): Promise<Models.AppKey>;
|
|
264
|
+
/**
|
|
265
|
+
* Create a new app key for an application. App keys carry no scopes; send one in the `X-Appwrite-Key` header alongside the `X-Appwrite-App` header to list the application's installations and create installation access tokens.
|
|
266
|
+
*
|
|
267
|
+
* @param {string} appId - Application unique ID.
|
|
268
|
+
* @throws {AppwriteException}
|
|
269
|
+
* @returns {Promise<Models.AppKey>}
|
|
270
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
271
|
+
*/
|
|
272
|
+
createKey(appId: string): Promise<Models.AppKey>;
|
|
273
|
+
/**
|
|
274
|
+
* Get an app key by its unique ID.
|
|
275
|
+
*
|
|
276
|
+
* @param {string} params.appId - Application unique ID.
|
|
277
|
+
* @param {string} params.keyId - App key unique ID.
|
|
278
|
+
* @throws {AppwriteException}
|
|
279
|
+
* @returns {Promise<Models.AppKey>}
|
|
280
|
+
*/
|
|
281
|
+
getKey(params: {
|
|
282
|
+
appId: string;
|
|
283
|
+
keyId: string;
|
|
284
|
+
}): Promise<Models.AppKey>;
|
|
285
|
+
/**
|
|
286
|
+
* Get an app key by its unique ID.
|
|
287
|
+
*
|
|
288
|
+
* @param {string} appId - Application unique ID.
|
|
289
|
+
* @param {string} keyId - App key unique ID.
|
|
290
|
+
* @throws {AppwriteException}
|
|
291
|
+
* @returns {Promise<Models.AppKey>}
|
|
292
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
293
|
+
*/
|
|
294
|
+
getKey(appId: string, keyId: string): Promise<Models.AppKey>;
|
|
295
|
+
/**
|
|
296
|
+
* Delete an app key by its unique ID.
|
|
297
|
+
*
|
|
298
|
+
* @param {string} params.appId - Application unique ID.
|
|
299
|
+
* @param {string} params.keyId - App key unique ID.
|
|
300
|
+
* @throws {AppwriteException}
|
|
301
|
+
* @returns {Promise<{}>}
|
|
302
|
+
*/
|
|
303
|
+
deleteKey(params: {
|
|
304
|
+
appId: string;
|
|
305
|
+
keyId: string;
|
|
306
|
+
}): Promise<{}>;
|
|
307
|
+
/**
|
|
308
|
+
* Delete an app key by its unique ID.
|
|
309
|
+
*
|
|
310
|
+
* @param {string} appId - Application unique ID.
|
|
311
|
+
* @param {string} keyId - App key unique ID.
|
|
312
|
+
* @throws {AppwriteException}
|
|
313
|
+
* @returns {Promise<{}>}
|
|
314
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
315
|
+
*/
|
|
316
|
+
deleteKey(appId: string, keyId: string): Promise<{}>;
|
|
216
317
|
/**
|
|
217
318
|
* Update the labels of an application. Labels are read-only for clients; only a server SDK using a project API key can set them. Replaces the previous labels.
|
|
218
319
|
*
|
|
@@ -38,6 +38,110 @@ export declare class Organization {
|
|
|
38
38
|
* @returns {Promise<{}>}
|
|
39
39
|
*/
|
|
40
40
|
delete(): Promise<{}>;
|
|
41
|
+
/**
|
|
42
|
+
* List app installations on the organization. Any organization member can read installations.
|
|
43
|
+
*
|
|
44
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
45
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
46
|
+
* @throws {AppwriteException}
|
|
47
|
+
* @returns {Promise<Models.AppInstallationList>}
|
|
48
|
+
*/
|
|
49
|
+
listInstallations(params?: {
|
|
50
|
+
queries?: string[];
|
|
51
|
+
total?: boolean;
|
|
52
|
+
}): Promise<Models.AppInstallationList>;
|
|
53
|
+
/**
|
|
54
|
+
* List app installations on the organization. Any organization member can read installations.
|
|
55
|
+
*
|
|
56
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
57
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
58
|
+
* @throws {AppwriteException}
|
|
59
|
+
* @returns {Promise<Models.AppInstallationList>}
|
|
60
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
61
|
+
*/
|
|
62
|
+
listInstallations(queries?: string[], total?: boolean): Promise<Models.AppInstallationList>;
|
|
63
|
+
/**
|
|
64
|
+
* Install an app on the organization. Only organization members with the owner role can install apps. The installation is granted the scopes the app currently requests.
|
|
65
|
+
*
|
|
66
|
+
* @param {string} params.appId - Application unique ID.
|
|
67
|
+
* @param {string} params.authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
|
|
68
|
+
* @throws {AppwriteException}
|
|
69
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
70
|
+
*/
|
|
71
|
+
createInstallation(params: {
|
|
72
|
+
appId: string;
|
|
73
|
+
authorizationDetails?: string;
|
|
74
|
+
}): Promise<Models.AppInstallation>;
|
|
75
|
+
/**
|
|
76
|
+
* Install an app on the organization. Only organization members with the owner role can install apps. The installation is granted the scopes the app currently requests.
|
|
77
|
+
*
|
|
78
|
+
* @param {string} appId - Application unique ID.
|
|
79
|
+
* @param {string} authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
|
|
80
|
+
* @throws {AppwriteException}
|
|
81
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
82
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
83
|
+
*/
|
|
84
|
+
createInstallation(appId: string, authorizationDetails?: string): Promise<Models.AppInstallation>;
|
|
85
|
+
/**
|
|
86
|
+
* Get an app installation on the organization by its unique ID. Any organization member can read installations.
|
|
87
|
+
*
|
|
88
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
89
|
+
* @throws {AppwriteException}
|
|
90
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
91
|
+
*/
|
|
92
|
+
getInstallation(params: {
|
|
93
|
+
installationId: string;
|
|
94
|
+
}): Promise<Models.AppInstallation>;
|
|
95
|
+
/**
|
|
96
|
+
* Get an app installation on the organization by its unique ID. Any organization member can read installations.
|
|
97
|
+
*
|
|
98
|
+
* @param {string} installationId - Installation unique ID.
|
|
99
|
+
* @throws {AppwriteException}
|
|
100
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
101
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
102
|
+
*/
|
|
103
|
+
getInstallation(installationId: string): Promise<Models.AppInstallation>;
|
|
104
|
+
/**
|
|
105
|
+
* Update an app installation on the organization. Only organization members with the owner role can update installations. The installation's granted scopes are refreshed to the scopes the app currently requests; previously issued installation access tokens are revoked.
|
|
106
|
+
*
|
|
107
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
108
|
+
* @param {string} params.authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
|
|
109
|
+
* @throws {AppwriteException}
|
|
110
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
111
|
+
*/
|
|
112
|
+
updateInstallation(params: {
|
|
113
|
+
installationId: string;
|
|
114
|
+
authorizationDetails?: string;
|
|
115
|
+
}): Promise<Models.AppInstallation>;
|
|
116
|
+
/**
|
|
117
|
+
* Update an app installation on the organization. Only organization members with the owner role can update installations. The installation's granted scopes are refreshed to the scopes the app currently requests; previously issued installation access tokens are revoked.
|
|
118
|
+
*
|
|
119
|
+
* @param {string} installationId - Installation unique ID.
|
|
120
|
+
* @param {string} authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
|
|
121
|
+
* @throws {AppwriteException}
|
|
122
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
123
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
|
+
*/
|
|
125
|
+
updateInstallation(installationId: string, authorizationDetails?: string): Promise<Models.AppInstallation>;
|
|
126
|
+
/**
|
|
127
|
+
* Uninstall an app from the organization by its installation ID. Only organization members with the owner role can remove installations. Previously issued installation access tokens are revoked.
|
|
128
|
+
*
|
|
129
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
130
|
+
* @throws {AppwriteException}
|
|
131
|
+
* @returns {Promise<{}>}
|
|
132
|
+
*/
|
|
133
|
+
deleteInstallation(params: {
|
|
134
|
+
installationId: string;
|
|
135
|
+
}): Promise<{}>;
|
|
136
|
+
/**
|
|
137
|
+
* Uninstall an app from the organization by its installation ID. Only organization members with the owner role can remove installations. Previously issued installation access tokens are revoked.
|
|
138
|
+
*
|
|
139
|
+
* @param {string} installationId - Installation unique ID.
|
|
140
|
+
* @throws {AppwriteException}
|
|
141
|
+
* @returns {Promise<{}>}
|
|
142
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
143
|
+
*/
|
|
144
|
+
deleteInstallation(installationId: string): Promise<{}>;
|
|
41
145
|
/**
|
|
42
146
|
* Get a list of all API keys from the current organization.
|
|
43
147
|
*
|
|
@@ -353,6 +353,7 @@ export declare class Project {
|
|
|
353
353
|
* @param {number} params.refreshTokenDuration - Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.
|
|
354
354
|
* @param {number} params.publicAccessTokenDuration - Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.
|
|
355
355
|
* @param {number} params.publicRefreshTokenDuration - Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.
|
|
356
|
+
* @param {number} params.installationAccessTokenDuration - Access token duration in seconds for app installation access tokens. Leave empty to use default 1 hour.
|
|
356
357
|
* @param {boolean} params.confidentialPkce - When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
|
|
357
358
|
* @param {string} params.verificationUrl - URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.
|
|
358
359
|
* @param {number} params.userCodeLength - Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.
|
|
@@ -371,6 +372,7 @@ export declare class Project {
|
|
|
371
372
|
refreshTokenDuration?: number;
|
|
372
373
|
publicAccessTokenDuration?: number;
|
|
373
374
|
publicRefreshTokenDuration?: number;
|
|
375
|
+
installationAccessTokenDuration?: number;
|
|
374
376
|
confidentialPkce?: boolean;
|
|
375
377
|
verificationUrl?: string;
|
|
376
378
|
userCodeLength?: number;
|
|
@@ -389,6 +391,7 @@ export declare class Project {
|
|
|
389
391
|
* @param {number} refreshTokenDuration - Refresh token duration in seconds for confidential clients (server-side apps that authenticate with a client secret). Leave empty to use default 1 year.
|
|
390
392
|
* @param {number} publicAccessTokenDuration - Access token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 1 hour.
|
|
391
393
|
* @param {number} publicRefreshTokenDuration - Refresh token duration in seconds for public clients (SPAs, mobile, and native apps that cannot keep a client secret). Leave empty to use default 30 days.
|
|
394
|
+
* @param {number} installationAccessTokenDuration - Access token duration in seconds for app installation access tokens. Leave empty to use default 1 hour.
|
|
392
395
|
* @param {boolean} confidentialPkce - When enabled, PKCE is required for confidential clients (server-side flows using client_secret). PKCE is always required for public clients regardless of this setting.
|
|
393
396
|
* @param {string} verificationUrl - URL to your application page where users enter the device flow user code. Required to enable the Device Authorization Grant.
|
|
394
397
|
* @param {number} userCodeLength - Number of characters in the device flow user code, excluding the formatting separator. Shorter codes are easier to type but weaker; pair short codes with short expiry. Leave empty to use default 8.
|
|
@@ -399,7 +402,7 @@ export declare class Project {
|
|
|
399
402
|
* @returns {Promise<Models.Project>}
|
|
400
403
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
401
404
|
*/
|
|
402
|
-
updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], authorizationDetailsTypes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, confidentialPkce?: boolean, verificationUrl?: string, userCodeLength?: number, userCodeFormat?: string, deviceCodeDuration?: number, defaultScopes?: string[]): Promise<Models.Project>;
|
|
405
|
+
updateOAuth2Server(enabled: boolean, authorizationUrl: string, scopes?: string[], authorizationDetailsTypes?: string[], accessTokenDuration?: number, refreshTokenDuration?: number, publicAccessTokenDuration?: number, publicRefreshTokenDuration?: number, installationAccessTokenDuration?: number, confidentialPkce?: boolean, verificationUrl?: string, userCodeLength?: number, userCodeFormat?: string, deviceCodeDuration?: number, defaultScopes?: string[]): Promise<Models.Project>;
|
|
403
406
|
/**
|
|
404
407
|
* Update the project OAuth2 Amazon configuration.
|
|
405
408
|
*
|
|
@@ -186,31 +186,6 @@ export declare class Projects {
|
|
|
186
186
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
187
187
|
*/
|
|
188
188
|
listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
|
|
189
|
-
/**
|
|
190
|
-
* Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
|
|
191
|
-
*
|
|
192
|
-
* @param {string} params.projectId - Project unique ID.
|
|
193
|
-
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
194
|
-
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
195
|
-
* @throws {AppwriteException}
|
|
196
|
-
* @returns {Promise<Models.DevKey>}
|
|
197
|
-
*/
|
|
198
|
-
createDevKey(params: {
|
|
199
|
-
projectId: string;
|
|
200
|
-
name: string;
|
|
201
|
-
expire: string;
|
|
202
|
-
}): Promise<Models.DevKey>;
|
|
203
|
-
/**
|
|
204
|
-
* Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
|
|
205
|
-
*
|
|
206
|
-
* @param {string} projectId - Project unique ID.
|
|
207
|
-
* @param {string} name - Key name. Max length: 128 chars.
|
|
208
|
-
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
209
|
-
* @throws {AppwriteException}
|
|
210
|
-
* @returns {Promise<Models.DevKey>}
|
|
211
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
212
|
-
*/
|
|
213
|
-
createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey>;
|
|
214
189
|
/**
|
|
215
190
|
* Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
|
|
216
191
|
*
|
|
@@ -113,6 +113,125 @@ export declare class Teams {
|
|
|
113
113
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
114
114
|
*/
|
|
115
115
|
delete(teamId: string): Promise<{}>;
|
|
116
|
+
/**
|
|
117
|
+
* List app installations on a team. Any team member can read installations.
|
|
118
|
+
*
|
|
119
|
+
* @param {string} params.teamId - Team ID.
|
|
120
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
121
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
122
|
+
* @throws {AppwriteException}
|
|
123
|
+
* @returns {Promise<Models.AppInstallationList>}
|
|
124
|
+
*/
|
|
125
|
+
listInstallations(params: {
|
|
126
|
+
teamId: string;
|
|
127
|
+
queries?: string[];
|
|
128
|
+
total?: boolean;
|
|
129
|
+
}): Promise<Models.AppInstallationList>;
|
|
130
|
+
/**
|
|
131
|
+
* List app installations on a team. Any team member can read installations.
|
|
132
|
+
*
|
|
133
|
+
* @param {string} teamId - Team ID.
|
|
134
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
135
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
136
|
+
* @throws {AppwriteException}
|
|
137
|
+
* @returns {Promise<Models.AppInstallationList>}
|
|
138
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
139
|
+
*/
|
|
140
|
+
listInstallations(teamId: string, queries?: string[], total?: boolean): Promise<Models.AppInstallationList>;
|
|
141
|
+
/**
|
|
142
|
+
* Install an app on a team. When authenticated as a user, only team members with the owner role can install apps. Requests using an API key or in admin mode can install apps on any team. The installation is granted the scopes the app currently requests.
|
|
143
|
+
*
|
|
144
|
+
* @param {string} params.teamId - Team ID.
|
|
145
|
+
* @param {string} params.appId - Application unique ID.
|
|
146
|
+
* @param {string} params.authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
|
|
147
|
+
* @throws {AppwriteException}
|
|
148
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
149
|
+
*/
|
|
150
|
+
createInstallation(params: {
|
|
151
|
+
teamId: string;
|
|
152
|
+
appId: string;
|
|
153
|
+
authorizationDetails?: string;
|
|
154
|
+
}): Promise<Models.AppInstallation>;
|
|
155
|
+
/**
|
|
156
|
+
* Install an app on a team. When authenticated as a user, only team members with the owner role can install apps. Requests using an API key or in admin mode can install apps on any team. The installation is granted the scopes the app currently requests.
|
|
157
|
+
*
|
|
158
|
+
* @param {string} teamId - Team ID.
|
|
159
|
+
* @param {string} appId - Application unique ID.
|
|
160
|
+
* @param {string} authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. The Appwrite Console stores authorized project IDs here.
|
|
161
|
+
* @throws {AppwriteException}
|
|
162
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
163
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
164
|
+
*/
|
|
165
|
+
createInstallation(teamId: string, appId: string, authorizationDetails?: string): Promise<Models.AppInstallation>;
|
|
166
|
+
/**
|
|
167
|
+
* Get an app installation on a team by its unique ID. Any team member can read installations.
|
|
168
|
+
*
|
|
169
|
+
* @param {string} params.teamId - Team ID.
|
|
170
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
171
|
+
* @throws {AppwriteException}
|
|
172
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
173
|
+
*/
|
|
174
|
+
getInstallation(params: {
|
|
175
|
+
teamId: string;
|
|
176
|
+
installationId: string;
|
|
177
|
+
}): Promise<Models.AppInstallation>;
|
|
178
|
+
/**
|
|
179
|
+
* Get an app installation on a team by its unique ID. Any team member can read installations.
|
|
180
|
+
*
|
|
181
|
+
* @param {string} teamId - Team ID.
|
|
182
|
+
* @param {string} installationId - Installation unique ID.
|
|
183
|
+
* @throws {AppwriteException}
|
|
184
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
185
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
186
|
+
*/
|
|
187
|
+
getInstallation(teamId: string, installationId: string): Promise<Models.AppInstallation>;
|
|
188
|
+
/**
|
|
189
|
+
* Update an app installation on a team. Only team members with the owner role can update installations. The installation's granted scopes are refreshed to the scopes the app currently requests; previously issued installation access tokens are revoked.
|
|
190
|
+
*
|
|
191
|
+
* @param {string} params.teamId - Team ID.
|
|
192
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
193
|
+
* @param {string} params.authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
|
|
194
|
+
* @throws {AppwriteException}
|
|
195
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
196
|
+
*/
|
|
197
|
+
updateInstallation(params: {
|
|
198
|
+
teamId: string;
|
|
199
|
+
installationId: string;
|
|
200
|
+
authorizationDetails?: string;
|
|
201
|
+
}): Promise<Models.AppInstallation>;
|
|
202
|
+
/**
|
|
203
|
+
* Update an app installation on a team. Only team members with the owner role can update installations. The installation's granted scopes are refreshed to the scopes the app currently requests; previously issued installation access tokens are revoked.
|
|
204
|
+
*
|
|
205
|
+
* @param {string} teamId - Team ID.
|
|
206
|
+
* @param {string} installationId - Installation unique ID.
|
|
207
|
+
* @param {string} authorizationDetails - Authorization details granted to the installation as a JSON array of objects, each with a `type` and app-defined fields. Omit to keep the current value.
|
|
208
|
+
* @throws {AppwriteException}
|
|
209
|
+
* @returns {Promise<Models.AppInstallation>}
|
|
210
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
211
|
+
*/
|
|
212
|
+
updateInstallation(teamId: string, installationId: string, authorizationDetails?: string): Promise<Models.AppInstallation>;
|
|
213
|
+
/**
|
|
214
|
+
* Uninstall an app from a team by its installation ID. Only team members with the owner role can remove installations. Previously issued installation access tokens are revoked.
|
|
215
|
+
*
|
|
216
|
+
* @param {string} params.teamId - Team ID.
|
|
217
|
+
* @param {string} params.installationId - Installation unique ID.
|
|
218
|
+
* @throws {AppwriteException}
|
|
219
|
+
* @returns {Promise<{}>}
|
|
220
|
+
*/
|
|
221
|
+
deleteInstallation(params: {
|
|
222
|
+
teamId: string;
|
|
223
|
+
installationId: string;
|
|
224
|
+
}): Promise<{}>;
|
|
225
|
+
/**
|
|
226
|
+
* Uninstall an app from a team by its installation ID. Only team members with the owner role can remove installations. Previously issued installation access tokens are revoked.
|
|
227
|
+
*
|
|
228
|
+
* @param {string} teamId - Team ID.
|
|
229
|
+
* @param {string} installationId - Installation unique ID.
|
|
230
|
+
* @throws {AppwriteException}
|
|
231
|
+
* @returns {Promise<{}>}
|
|
232
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
233
|
+
*/
|
|
234
|
+
deleteInstallation(teamId: string, installationId: string): Promise<{}>;
|
|
116
235
|
/**
|
|
117
236
|
* Get the team activity logs list by its unique ID.
|
|
118
237
|
*
|
|
@@ -606,6 +606,42 @@ export declare class VectorsDB {
|
|
|
606
606
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
607
607
|
*/
|
|
608
608
|
deleteDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
|
|
609
|
+
/**
|
|
610
|
+
* Get a list of all the user's documents in a given collection using a POST request. This behaves identically to the list documents endpoint but accepts the queries in the request body, allowing much larger `queries` arrays than can fit in a URL query string.
|
|
611
|
+
*
|
|
612
|
+
*
|
|
613
|
+
* @param {string} params.databaseId - Database ID.
|
|
614
|
+
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
615
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
616
|
+
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
617
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
618
|
+
* @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
619
|
+
* @throws {AppwriteException}
|
|
620
|
+
* @returns {Promise<Models.DocumentList<Document>>}
|
|
621
|
+
*/
|
|
622
|
+
createQuery<Document extends Models.Document = Models.DefaultDocument>(params: {
|
|
623
|
+
databaseId: string;
|
|
624
|
+
collectionId: string;
|
|
625
|
+
queries?: string[];
|
|
626
|
+
transactionId?: string;
|
|
627
|
+
total?: boolean;
|
|
628
|
+
ttl?: number;
|
|
629
|
+
}): Promise<Models.DocumentList<Document>>;
|
|
630
|
+
/**
|
|
631
|
+
* Get a list of all the user's documents in a given collection using a POST request. This behaves identically to the list documents endpoint but accepts the queries in the request body, allowing much larger `queries` arrays than can fit in a URL query string.
|
|
632
|
+
*
|
|
633
|
+
*
|
|
634
|
+
* @param {string} databaseId - Database ID.
|
|
635
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
636
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
637
|
+
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
638
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
639
|
+
* @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
640
|
+
* @throws {AppwriteException}
|
|
641
|
+
* @returns {Promise<Models.DocumentList<Document>>}
|
|
642
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
643
|
+
*/
|
|
644
|
+
createQuery<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
|
|
609
645
|
/**
|
|
610
646
|
* Get a document by its unique ID. This endpoint response returns a JSON object with the document data.
|
|
611
647
|
*
|