@appwrite.io/console 13.2.0 → 14.0.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 +1054 -249
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1054 -249
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1054 -249
- package/package.json +1 -1
- package/types/enums/project-key-scopes.d.ts +1 -0
- package/types/models.d.ts +143 -225
- package/types/services/apps.d.ts +44 -8
- package/types/services/compute.d.ts +23 -120
- package/types/services/databases.d.ts +24 -24
- package/types/services/documents-db.d.ts +4 -1
- package/types/services/organizations.d.ts +8 -8
- package/types/services/project.d.ts +20 -2
- package/types/services/tables-db.d.ts +28 -25
- package/types/services/vectors-db.d.ts +4 -1
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@appwrite.io/console",
|
|
3
3
|
"homepage": "https://appwrite.io/support",
|
|
4
4
|
"description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "14.0.0",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
7
7
|
"main": "dist/cjs/sdk.js",
|
|
8
8
|
"exports": {
|
|
@@ -89,6 +89,7 @@ export declare enum ProjectKeyScopes {
|
|
|
89
89
|
ArchivesWrite = "archives.write",
|
|
90
90
|
RestorationsRead = "restorations.read",
|
|
91
91
|
RestorationsWrite = "restorations.write",
|
|
92
|
+
DedicatedDatabasesExecute = "dedicatedDatabases.execute",
|
|
92
93
|
DomainsRead = "domains.read",
|
|
93
94
|
DomainsWrite = "domains.write",
|
|
94
95
|
EventsRead = "events.read",
|
package/types/models.d.ts
CHANGED
|
@@ -1490,7 +1490,7 @@ export declare namespace Models {
|
|
|
1490
1490
|
/**
|
|
1491
1491
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1492
1492
|
*/
|
|
1493
|
-
default?:
|
|
1493
|
+
default?: number[];
|
|
1494
1494
|
};
|
|
1495
1495
|
/**
|
|
1496
1496
|
* AttributeLine
|
|
@@ -1531,7 +1531,7 @@ export declare namespace Models {
|
|
|
1531
1531
|
/**
|
|
1532
1532
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1533
1533
|
*/
|
|
1534
|
-
default?:
|
|
1534
|
+
default?: number[][];
|
|
1535
1535
|
};
|
|
1536
1536
|
/**
|
|
1537
1537
|
* AttributePolygon
|
|
@@ -1572,7 +1572,7 @@ export declare namespace Models {
|
|
|
1572
1572
|
/**
|
|
1573
1573
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1574
1574
|
*/
|
|
1575
|
-
default?:
|
|
1575
|
+
default?: number[][][];
|
|
1576
1576
|
};
|
|
1577
1577
|
/**
|
|
1578
1578
|
* AttributeVarchar
|
|
@@ -2680,7 +2680,7 @@ export declare namespace Models {
|
|
|
2680
2680
|
/**
|
|
2681
2681
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2682
2682
|
*/
|
|
2683
|
-
default?:
|
|
2683
|
+
default?: number[];
|
|
2684
2684
|
};
|
|
2685
2685
|
/**
|
|
2686
2686
|
* ColumnLine
|
|
@@ -2721,7 +2721,7 @@ export declare namespace Models {
|
|
|
2721
2721
|
/**
|
|
2722
2722
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2723
2723
|
*/
|
|
2724
|
-
default?:
|
|
2724
|
+
default?: number[][];
|
|
2725
2725
|
};
|
|
2726
2726
|
/**
|
|
2727
2727
|
* ColumnPolygon
|
|
@@ -2762,7 +2762,7 @@ export declare namespace Models {
|
|
|
2762
2762
|
/**
|
|
2763
2763
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2764
2764
|
*/
|
|
2765
|
-
default?:
|
|
2765
|
+
default?: number[][][];
|
|
2766
2766
|
};
|
|
2767
2767
|
/**
|
|
2768
2768
|
* ColumnVarchar
|
|
@@ -3306,6 +3306,26 @@ export declare namespace Models {
|
|
|
3306
3306
|
* Email verification status.
|
|
3307
3307
|
*/
|
|
3308
3308
|
emailVerification: boolean;
|
|
3309
|
+
/**
|
|
3310
|
+
* Canonical form of the user email address.
|
|
3311
|
+
*/
|
|
3312
|
+
emailCanonical?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Whether the user email is from a free email provider.
|
|
3315
|
+
*/
|
|
3316
|
+
emailIsFree?: boolean;
|
|
3317
|
+
/**
|
|
3318
|
+
* Whether the user email is from a disposable email provider.
|
|
3319
|
+
*/
|
|
3320
|
+
emailIsDisposable?: boolean;
|
|
3321
|
+
/**
|
|
3322
|
+
* Whether the user email is from a corporate domain.
|
|
3323
|
+
*/
|
|
3324
|
+
emailIsCorporate?: boolean;
|
|
3325
|
+
/**
|
|
3326
|
+
* Whether the user email is in its canonical form.
|
|
3327
|
+
*/
|
|
3328
|
+
emailIsCanonical?: boolean;
|
|
3309
3329
|
/**
|
|
3310
3330
|
* Phone verification status.
|
|
3311
3331
|
*/
|
|
@@ -3936,6 +3956,10 @@ export declare namespace Models {
|
|
|
3936
3956
|
* Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.
|
|
3937
3957
|
*/
|
|
3938
3958
|
mfa: boolean;
|
|
3959
|
+
/**
|
|
3960
|
+
* Most recent access date in ISO 8601 format. Show this attribute by toggling membership privacy in the Console.
|
|
3961
|
+
*/
|
|
3962
|
+
userAccessedAt: string;
|
|
3939
3963
|
/**
|
|
3940
3964
|
* User list of roles
|
|
3941
3965
|
*/
|
|
@@ -5106,6 +5130,10 @@ export declare namespace Models {
|
|
|
5106
5130
|
* OAuth2 server allowed scopes
|
|
5107
5131
|
*/
|
|
5108
5132
|
oAuth2ServerScopes: string[];
|
|
5133
|
+
/**
|
|
5134
|
+
* OAuth2 server accepted RFC 9396 authorization_details types
|
|
5135
|
+
*/
|
|
5136
|
+
oAuth2ServerAuthorizationDetailsTypes: string[];
|
|
5109
5137
|
/**
|
|
5110
5138
|
* OAuth2 server access token duration in seconds for confidential clients
|
|
5111
5139
|
*/
|
|
@@ -5126,6 +5154,22 @@ export declare namespace Models {
|
|
|
5126
5154
|
* 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.
|
|
5127
5155
|
*/
|
|
5128
5156
|
oAuth2ServerConfidentialPkce: boolean;
|
|
5157
|
+
/**
|
|
5158
|
+
* URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.
|
|
5159
|
+
*/
|
|
5160
|
+
oAuth2ServerVerificationUrl: string;
|
|
5161
|
+
/**
|
|
5162
|
+
* Number of characters in the device flow user code, excluding the formatting separator.
|
|
5163
|
+
*/
|
|
5164
|
+
oAuth2ServerUserCodeLength: number;
|
|
5165
|
+
/**
|
|
5166
|
+
* Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.
|
|
5167
|
+
*/
|
|
5168
|
+
oAuth2ServerUserCodeFormat: string;
|
|
5169
|
+
/**
|
|
5170
|
+
* Lifetime in seconds of device flow device codes and user codes.
|
|
5171
|
+
*/
|
|
5172
|
+
oAuth2ServerDeviceCodeDuration: number;
|
|
5129
5173
|
/**
|
|
5130
5174
|
* OAuth2 server discovery URL
|
|
5131
5175
|
*/
|
|
@@ -6445,6 +6489,10 @@ export declare namespace Models {
|
|
|
6445
6489
|
* Whether user MFA status is visible in memberships.
|
|
6446
6490
|
*/
|
|
6447
6491
|
userMFA: boolean;
|
|
6492
|
+
/**
|
|
6493
|
+
* Whether user last access time is visible in memberships.
|
|
6494
|
+
*/
|
|
6495
|
+
userAccessedAt: boolean;
|
|
6448
6496
|
};
|
|
6449
6497
|
/**
|
|
6450
6498
|
* Platform Web
|
|
@@ -8988,54 +9036,6 @@ export declare namespace Models {
|
|
|
8988
9036
|
* Hostname.
|
|
8989
9037
|
*/
|
|
8990
9038
|
hostname: string;
|
|
8991
|
-
/**
|
|
8992
|
-
* Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
|
|
8993
|
-
*/
|
|
8994
|
-
osCode: string;
|
|
8995
|
-
/**
|
|
8996
|
-
* Operating system name.
|
|
8997
|
-
*/
|
|
8998
|
-
osName: string;
|
|
8999
|
-
/**
|
|
9000
|
-
* Operating system version.
|
|
9001
|
-
*/
|
|
9002
|
-
osVersion: string;
|
|
9003
|
-
/**
|
|
9004
|
-
* Client type.
|
|
9005
|
-
*/
|
|
9006
|
-
clientType: string;
|
|
9007
|
-
/**
|
|
9008
|
-
* Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
|
|
9009
|
-
*/
|
|
9010
|
-
clientCode: string;
|
|
9011
|
-
/**
|
|
9012
|
-
* Client name.
|
|
9013
|
-
*/
|
|
9014
|
-
clientName: string;
|
|
9015
|
-
/**
|
|
9016
|
-
* Client version.
|
|
9017
|
-
*/
|
|
9018
|
-
clientVersion: string;
|
|
9019
|
-
/**
|
|
9020
|
-
* Client engine name.
|
|
9021
|
-
*/
|
|
9022
|
-
clientEngine: string;
|
|
9023
|
-
/**
|
|
9024
|
-
* Client engine name.
|
|
9025
|
-
*/
|
|
9026
|
-
clientEngineVersion: string;
|
|
9027
|
-
/**
|
|
9028
|
-
* Device name.
|
|
9029
|
-
*/
|
|
9030
|
-
deviceName: string;
|
|
9031
|
-
/**
|
|
9032
|
-
* Device brand name.
|
|
9033
|
-
*/
|
|
9034
|
-
deviceBrand: string;
|
|
9035
|
-
/**
|
|
9036
|
-
* Device model name.
|
|
9037
|
-
*/
|
|
9038
|
-
deviceModel: string;
|
|
9039
9039
|
/**
|
|
9040
9040
|
* Country two-character ISO 3166-1 alpha code.
|
|
9041
9041
|
*/
|
|
@@ -9939,6 +9939,38 @@ export declare namespace Models {
|
|
|
9939
9939
|
* Unix timestamp when the branch expires.
|
|
9940
9940
|
*/
|
|
9941
9941
|
expiresAt: number;
|
|
9942
|
+
/**
|
|
9943
|
+
* Branch hostname for direct connections.
|
|
9944
|
+
*/
|
|
9945
|
+
host: string;
|
|
9946
|
+
/**
|
|
9947
|
+
* Branch port.
|
|
9948
|
+
*/
|
|
9949
|
+
port: number;
|
|
9950
|
+
/**
|
|
9951
|
+
* Database name the client sends for routing to the branch.
|
|
9952
|
+
*/
|
|
9953
|
+
database: string;
|
|
9954
|
+
/**
|
|
9955
|
+
* Database username. Shared with the parent database.
|
|
9956
|
+
*/
|
|
9957
|
+
username: string;
|
|
9958
|
+
/**
|
|
9959
|
+
* Database password. Shared with the parent database.
|
|
9960
|
+
*/
|
|
9961
|
+
password: string;
|
|
9962
|
+
/**
|
|
9963
|
+
* Whether SSL is required.
|
|
9964
|
+
*/
|
|
9965
|
+
ssl: boolean;
|
|
9966
|
+
/**
|
|
9967
|
+
* Database engine. Possible values: postgres, mysql, mariadb, mongodb.
|
|
9968
|
+
*/
|
|
9969
|
+
engine: string;
|
|
9970
|
+
/**
|
|
9971
|
+
* Full connection string for the branch.
|
|
9972
|
+
*/
|
|
9973
|
+
connectionString: string;
|
|
9942
9974
|
};
|
|
9943
9975
|
/**
|
|
9944
9976
|
* BranchList
|
|
@@ -10092,6 +10124,18 @@ export declare namespace Models {
|
|
|
10092
10124
|
* Database name.
|
|
10093
10125
|
*/
|
|
10094
10126
|
database: string;
|
|
10127
|
+
/**
|
|
10128
|
+
* Database TCP hostname or address.
|
|
10129
|
+
*/
|
|
10130
|
+
tcpHost: string;
|
|
10131
|
+
/**
|
|
10132
|
+
* Database TCP port.
|
|
10133
|
+
*/
|
|
10134
|
+
tcpPort: number;
|
|
10135
|
+
/**
|
|
10136
|
+
* Database name for direct TCP connections.
|
|
10137
|
+
*/
|
|
10138
|
+
tcpDatabase: string;
|
|
10095
10139
|
/**
|
|
10096
10140
|
* Database engine. Possible values: postgres, mysql, mariadb, mongodb.
|
|
10097
10141
|
*/
|
|
@@ -10180,55 +10224,6 @@ export declare namespace Models {
|
|
|
10180
10224
|
*/
|
|
10181
10225
|
available: number;
|
|
10182
10226
|
};
|
|
10183
|
-
/**
|
|
10184
|
-
* DatabaseMetrics
|
|
10185
|
-
*/
|
|
10186
|
-
export type DedicatedDatabaseMetrics = {
|
|
10187
|
-
/**
|
|
10188
|
-
* Metrics aggregation period. Possible values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).
|
|
10189
|
-
*/
|
|
10190
|
-
period: string;
|
|
10191
|
-
/**
|
|
10192
|
-
* Average CPU usage percentage.
|
|
10193
|
-
*/
|
|
10194
|
-
cpuPercent: number;
|
|
10195
|
-
/**
|
|
10196
|
-
* Average memory usage percentage.
|
|
10197
|
-
*/
|
|
10198
|
-
memoryPercent: number;
|
|
10199
|
-
/**
|
|
10200
|
-
* Memory used in bytes.
|
|
10201
|
-
*/
|
|
10202
|
-
memoryUsedBytes: number;
|
|
10203
|
-
/**
|
|
10204
|
-
* Maximum memory available in bytes.
|
|
10205
|
-
*/
|
|
10206
|
-
memoryMaxBytes: number;
|
|
10207
|
-
/**
|
|
10208
|
-
* Storage used in bytes.
|
|
10209
|
-
*/
|
|
10210
|
-
storageUsedBytes: number;
|
|
10211
|
-
/**
|
|
10212
|
-
* Current active connections.
|
|
10213
|
-
*/
|
|
10214
|
-
connectionsActive: number;
|
|
10215
|
-
/**
|
|
10216
|
-
* Maximum connections configured.
|
|
10217
|
-
*/
|
|
10218
|
-
connectionsMax: number;
|
|
10219
|
-
/**
|
|
10220
|
-
* Average read IOPS.
|
|
10221
|
-
*/
|
|
10222
|
-
iopsRead: number;
|
|
10223
|
-
/**
|
|
10224
|
-
* Average write IOPS.
|
|
10225
|
-
*/
|
|
10226
|
-
iopsWrite: number;
|
|
10227
|
-
/**
|
|
10228
|
-
* Queries per second.
|
|
10229
|
-
*/
|
|
10230
|
-
qps: number;
|
|
10231
|
-
};
|
|
10232
10227
|
/**
|
|
10233
10228
|
* DedicatedDatabase
|
|
10234
10229
|
*/
|
|
@@ -10253,18 +10248,10 @@ export declare namespace Models {
|
|
|
10253
10248
|
* Database display name.
|
|
10254
10249
|
*/
|
|
10255
10250
|
name: string;
|
|
10256
|
-
/**
|
|
10257
|
-
* Database type: shared (serverless) or dedicated (always-on).
|
|
10258
|
-
*/
|
|
10259
|
-
type: string;
|
|
10260
10251
|
/**
|
|
10261
10252
|
* Product API that owns this database: compute, documentsdb, or vectorsdb.
|
|
10262
10253
|
*/
|
|
10263
10254
|
api: string;
|
|
10264
|
-
/**
|
|
10265
|
-
* Region identifier (e.g., fra, nyc, syd).
|
|
10266
|
-
*/
|
|
10267
|
-
region: string;
|
|
10268
10255
|
/**
|
|
10269
10256
|
* Database engine: postgres, mysql, mariadb, or mongodb.
|
|
10270
10257
|
*/
|
|
@@ -10306,7 +10293,7 @@ export declare namespace Models {
|
|
|
10306
10293
|
*/
|
|
10307
10294
|
status: string;
|
|
10308
10295
|
/**
|
|
10309
|
-
* Container status for
|
|
10296
|
+
* Container status for lifecycle-managed database runtimes: active or inactive.
|
|
10310
10297
|
*/
|
|
10311
10298
|
containerStatus: string;
|
|
10312
10299
|
/**
|
|
@@ -10346,13 +10333,9 @@ export declare namespace Models {
|
|
|
10346
10333
|
*/
|
|
10347
10334
|
nodePool: string;
|
|
10348
10335
|
/**
|
|
10349
|
-
*
|
|
10336
|
+
* Number of high availability replicas. High availability is enabled when greater than 0.
|
|
10350
10337
|
*/
|
|
10351
|
-
|
|
10352
|
-
/**
|
|
10353
|
-
* Number of high availability replicas.
|
|
10354
|
-
*/
|
|
10355
|
-
highAvailabilityReplicaCount: number;
|
|
10338
|
+
replicas: number;
|
|
10356
10339
|
/**
|
|
10357
10340
|
* Replication sync mode: async, sync, or quorum.
|
|
10358
10341
|
*/
|
|
@@ -10418,7 +10401,7 @@ export declare namespace Models {
|
|
|
10418
10401
|
*/
|
|
10419
10402
|
sqlApiEnabled: boolean;
|
|
10420
10403
|
/**
|
|
10421
|
-
* Statement types accepted by the SQL API. Allowed values: SELECT, INSERT, UPDATE, DELETE.
|
|
10404
|
+
* Statement types accepted by the SQL API. Defaults to DML only; DDL/DCL types (CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE) are opt-in per database. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.
|
|
10422
10405
|
*/
|
|
10423
10406
|
sqlApiAllowedStatements: string[];
|
|
10424
10407
|
/**
|
|
@@ -11374,77 +11357,6 @@ export declare namespace Models {
|
|
|
11374
11357
|
*/
|
|
11375
11358
|
failed: boolean;
|
|
11376
11359
|
};
|
|
11377
|
-
/**
|
|
11378
|
-
* PerformanceInsights
|
|
11379
|
-
*/
|
|
11380
|
-
export type DedicatedDatabasePerformanceInsights = {
|
|
11381
|
-
/**
|
|
11382
|
-
* Top queries by total execution time.
|
|
11383
|
-
*/
|
|
11384
|
-
topQueries: DedicatedDatabasePerformanceInsightsQuery[];
|
|
11385
|
-
/**
|
|
11386
|
-
* Active wait events.
|
|
11387
|
-
*/
|
|
11388
|
-
waitEvents: DedicatedDatabasePerformanceInsightsWaitEvent[];
|
|
11389
|
-
/**
|
|
11390
|
-
* Total number of query calls.
|
|
11391
|
-
*/
|
|
11392
|
-
totalCalls: number;
|
|
11393
|
-
/**
|
|
11394
|
-
* Total query execution time in milliseconds.
|
|
11395
|
-
*/
|
|
11396
|
-
totalTimeMs: number;
|
|
11397
|
-
/**
|
|
11398
|
-
* Average query execution time in milliseconds.
|
|
11399
|
-
*/
|
|
11400
|
-
avgTimeMs: number;
|
|
11401
|
-
};
|
|
11402
|
-
/**
|
|
11403
|
-
* PerformanceInsightsQuery
|
|
11404
|
-
*/
|
|
11405
|
-
export type DedicatedDatabasePerformanceInsightsQuery = {
|
|
11406
|
-
/**
|
|
11407
|
-
* The SQL query text.
|
|
11408
|
-
*/
|
|
11409
|
-
query: string;
|
|
11410
|
-
/**
|
|
11411
|
-
* Number of times this query has been executed.
|
|
11412
|
-
*/
|
|
11413
|
-
calls: number;
|
|
11414
|
-
/**
|
|
11415
|
-
* Total execution time in milliseconds.
|
|
11416
|
-
*/
|
|
11417
|
-
totalTimeMs: number;
|
|
11418
|
-
/**
|
|
11419
|
-
* Mean execution time in milliseconds.
|
|
11420
|
-
*/
|
|
11421
|
-
meanTimeMs: number;
|
|
11422
|
-
/**
|
|
11423
|
-
* Total rows returned or affected.
|
|
11424
|
-
*/
|
|
11425
|
-
rows: number;
|
|
11426
|
-
};
|
|
11427
|
-
/**
|
|
11428
|
-
* PerformanceInsightsWaitEvent
|
|
11429
|
-
*/
|
|
11430
|
-
export type DedicatedDatabasePerformanceInsightsWaitEvent = {
|
|
11431
|
-
/**
|
|
11432
|
-
* Wait event name.
|
|
11433
|
-
*/
|
|
11434
|
-
event: string;
|
|
11435
|
-
/**
|
|
11436
|
-
* Wait event type or category.
|
|
11437
|
-
*/
|
|
11438
|
-
type: string;
|
|
11439
|
-
/**
|
|
11440
|
-
* Number of occurrences.
|
|
11441
|
-
*/
|
|
11442
|
-
count: number;
|
|
11443
|
-
/**
|
|
11444
|
-
* Total wait time in milliseconds.
|
|
11445
|
-
*/
|
|
11446
|
-
totalWaitMs: number;
|
|
11447
|
-
};
|
|
11448
11360
|
/**
|
|
11449
11361
|
* PITRWindows
|
|
11450
11362
|
*/
|
|
@@ -11622,6 +11534,10 @@ export declare namespace Models {
|
|
|
11622
11534
|
* Policy backup schedule in CRON format.
|
|
11623
11535
|
*/
|
|
11624
11536
|
schedule: string;
|
|
11537
|
+
/**
|
|
11538
|
+
* Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup).
|
|
11539
|
+
*/
|
|
11540
|
+
type: string;
|
|
11625
11541
|
/**
|
|
11626
11542
|
* Is this policy enabled.
|
|
11627
11543
|
*/
|
|
@@ -11890,36 +11806,6 @@ export declare namespace Models {
|
|
|
11890
11806
|
*/
|
|
11891
11807
|
roles: string[];
|
|
11892
11808
|
};
|
|
11893
|
-
/**
|
|
11894
|
-
* Schema
|
|
11895
|
-
*/
|
|
11896
|
-
export type DedicatedDatabaseSchema = {
|
|
11897
|
-
/**
|
|
11898
|
-
* List of tables with columns, types, and constraints.
|
|
11899
|
-
*/
|
|
11900
|
-
tables: Record<string, any>[];
|
|
11901
|
-
/**
|
|
11902
|
-
* List of indexes across all tables.
|
|
11903
|
-
*/
|
|
11904
|
-
indexes: Record<string, any>[];
|
|
11905
|
-
};
|
|
11906
|
-
/**
|
|
11907
|
-
* SchemaPreview
|
|
11908
|
-
*/
|
|
11909
|
-
export type DedicatedDatabaseSchemaPreview = {
|
|
11910
|
-
/**
|
|
11911
|
-
* Whether the engine supports transactional DDL for safe preview.
|
|
11912
|
-
*/
|
|
11913
|
-
supportsTransactionalDDL: boolean;
|
|
11914
|
-
/**
|
|
11915
|
-
* Schema change preview output.
|
|
11916
|
-
*/
|
|
11917
|
-
preview: string;
|
|
11918
|
-
/**
|
|
11919
|
-
* List of tables in the database after the change.
|
|
11920
|
-
*/
|
|
11921
|
-
tables: string[];
|
|
11922
|
-
};
|
|
11923
11809
|
/**
|
|
11924
11810
|
* SlowQuery
|
|
11925
11811
|
*/
|
|
@@ -12478,13 +12364,33 @@ export declare namespace Models {
|
|
|
12478
12364
|
*/
|
|
12479
12365
|
name: string;
|
|
12480
12366
|
/**
|
|
12481
|
-
*
|
|
12367
|
+
* Application description shown to users during OAuth2 consent.
|
|
12482
12368
|
*/
|
|
12483
|
-
|
|
12369
|
+
description: string;
|
|
12484
12370
|
/**
|
|
12485
|
-
*
|
|
12371
|
+
* Application homepage URL shown to users during OAuth2 consent.
|
|
12486
12372
|
*/
|
|
12487
|
-
|
|
12373
|
+
clientUri: string;
|
|
12374
|
+
/**
|
|
12375
|
+
* Application logo URL shown to users during OAuth2 consent.
|
|
12376
|
+
*/
|
|
12377
|
+
logoUri: string;
|
|
12378
|
+
/**
|
|
12379
|
+
* Application privacy policy URL shown to users during OAuth2 consent.
|
|
12380
|
+
*/
|
|
12381
|
+
privacyPolicyUrl: string;
|
|
12382
|
+
/**
|
|
12383
|
+
* Application terms of service URL shown to users during OAuth2 consent.
|
|
12384
|
+
*/
|
|
12385
|
+
termsUrl: string;
|
|
12386
|
+
/**
|
|
12387
|
+
* Application support or security contact emails.
|
|
12388
|
+
*/
|
|
12389
|
+
contacts: string[];
|
|
12390
|
+
/**
|
|
12391
|
+
* List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.
|
|
12392
|
+
*/
|
|
12393
|
+
redirectUris: string[];
|
|
12488
12394
|
/**
|
|
12489
12395
|
* Whether the app is enabled or not.
|
|
12490
12396
|
*/
|
|
@@ -12493,6 +12399,10 @@ export declare namespace Models {
|
|
|
12493
12399
|
* OAuth2 client type. `public` for SPAs, mobile, and native apps that cannot keep a client secret (PKCE required); `confidential` for server-side clients that authenticate with a client secret.
|
|
12494
12400
|
*/
|
|
12495
12401
|
type: string;
|
|
12402
|
+
/**
|
|
12403
|
+
* Whether this client may use the OAuth2 Device Authorization Grant (RFC 8628).
|
|
12404
|
+
*/
|
|
12405
|
+
deviceFlow: boolean;
|
|
12496
12406
|
/**
|
|
12497
12407
|
* ID of team that owns the application, if owned by team. Otherwise, user ID will be used.
|
|
12498
12408
|
*/
|
|
@@ -12527,9 +12437,13 @@ export declare namespace Models {
|
|
|
12527
12437
|
*/
|
|
12528
12438
|
appId: string;
|
|
12529
12439
|
/**
|
|
12530
|
-
*
|
|
12440
|
+
* Hashed application client secret.
|
|
12531
12441
|
*/
|
|
12532
12442
|
secret: string;
|
|
12443
|
+
/**
|
|
12444
|
+
* Last few characters of the client secret, used to help identify it.
|
|
12445
|
+
*/
|
|
12446
|
+
hint: string;
|
|
12533
12447
|
/**
|
|
12534
12448
|
* ID of the user who created the secret.
|
|
12535
12449
|
*/
|
|
@@ -12567,6 +12481,10 @@ export declare namespace Models {
|
|
|
12567
12481
|
* Application client secret. Returned in full only when the secret is created; subsequent reads return a masked value.
|
|
12568
12482
|
*/
|
|
12569
12483
|
secret: string;
|
|
12484
|
+
/**
|
|
12485
|
+
* Last few characters of the client secret, used to help identify it.
|
|
12486
|
+
*/
|
|
12487
|
+
hint: string;
|
|
12570
12488
|
/**
|
|
12571
12489
|
* ID of the user who created the secret.
|
|
12572
12490
|
*/
|
package/types/services/apps.d.ts
CHANGED
|
@@ -31,9 +31,15 @@ export declare class Apps {
|
|
|
31
31
|
* @param {string} params.appId - Application ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
32
32
|
* @param {string} params.name - Application name.
|
|
33
33
|
* @param {string[]} params.redirectUris - Redirect URIs (array of valid URLs).
|
|
34
|
+
* @param {string} params.description - Application description shown to users during OAuth2 consent.
|
|
35
|
+
* @param {string} params.clientUri - Application homepage URL shown to users during OAuth2 consent.
|
|
36
|
+
* @param {string} params.logoUri - Application logo URL shown to users during OAuth2 consent.
|
|
37
|
+
* @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
38
|
+
* @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
39
|
+
* @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
34
40
|
* @param {boolean} params.enabled - Is application enabled?
|
|
35
|
-
* @param {boolean} params.internal - When true, the application is restricted to the owner user or members of the configured team. Defaults to false (any user in the project can authorize).
|
|
36
41
|
* @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`.
|
|
42
|
+
* @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.
|
|
37
43
|
* @param {string} params.teamId - Team unique ID.
|
|
38
44
|
* @throws {AppwriteException}
|
|
39
45
|
* @returns {Promise<Models.App>}
|
|
@@ -42,9 +48,15 @@ export declare class Apps {
|
|
|
42
48
|
appId: string;
|
|
43
49
|
name: string;
|
|
44
50
|
redirectUris: string[];
|
|
51
|
+
description?: string;
|
|
52
|
+
clientUri?: string;
|
|
53
|
+
logoUri?: string;
|
|
54
|
+
privacyPolicyUrl?: string;
|
|
55
|
+
termsUrl?: string;
|
|
56
|
+
contacts?: string[];
|
|
45
57
|
enabled?: boolean;
|
|
46
|
-
internal?: boolean;
|
|
47
58
|
type?: string;
|
|
59
|
+
deviceFlow?: boolean;
|
|
48
60
|
teamId?: string;
|
|
49
61
|
}): Promise<Models.App>;
|
|
50
62
|
/**
|
|
@@ -53,15 +65,21 @@ export declare class Apps {
|
|
|
53
65
|
* @param {string} appId - Application ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
54
66
|
* @param {string} name - Application name.
|
|
55
67
|
* @param {string[]} redirectUris - Redirect URIs (array of valid URLs).
|
|
68
|
+
* @param {string} description - Application description shown to users during OAuth2 consent.
|
|
69
|
+
* @param {string} clientUri - Application homepage URL shown to users during OAuth2 consent.
|
|
70
|
+
* @param {string} logoUri - Application logo URL shown to users during OAuth2 consent.
|
|
71
|
+
* @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
72
|
+
* @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
73
|
+
* @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
56
74
|
* @param {boolean} enabled - Is application enabled?
|
|
57
|
-
* @param {boolean} internal - When true, the application is restricted to the owner user or members of the configured team. Defaults to false (any user in the project can authorize).
|
|
58
75
|
* @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`.
|
|
76
|
+
* @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.
|
|
59
77
|
* @param {string} teamId - Team unique ID.
|
|
60
78
|
* @throws {AppwriteException}
|
|
61
79
|
* @returns {Promise<Models.App>}
|
|
62
80
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
63
81
|
*/
|
|
64
|
-
create(appId: string, name: string, redirectUris: string[],
|
|
82
|
+
create(appId: string, name: string, redirectUris: string[], description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], enabled?: boolean, type?: string, deviceFlow?: boolean, teamId?: string): Promise<Models.App>;
|
|
65
83
|
/**
|
|
66
84
|
* Get an application by its unique ID.
|
|
67
85
|
*
|
|
@@ -86,35 +104,53 @@ export declare class Apps {
|
|
|
86
104
|
*
|
|
87
105
|
* @param {string} params.appId - Application unique ID.
|
|
88
106
|
* @param {string} params.name - Application name.
|
|
107
|
+
* @param {string} params.description - Application description shown to users during OAuth2 consent.
|
|
108
|
+
* @param {string} params.clientUri - Application homepage URL shown to users during OAuth2 consent.
|
|
109
|
+
* @param {string} params.logoUri - Application logo URL shown to users during OAuth2 consent.
|
|
110
|
+
* @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
111
|
+
* @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
112
|
+
* @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
89
113
|
* @param {boolean} params.enabled - Is application enabled?
|
|
90
|
-
* @param {boolean} params.internal - When true, the application is restricted to the owner user or members of the configured team. Defaults to false (any user in the project can authorize).
|
|
91
114
|
* @param {string[]} params.redirectUris - Redirect URIs (array of valid URLs).
|
|
92
115
|
* @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`.
|
|
116
|
+
* @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.
|
|
93
117
|
* @throws {AppwriteException}
|
|
94
118
|
* @returns {Promise<Models.App>}
|
|
95
119
|
*/
|
|
96
120
|
update(params: {
|
|
97
121
|
appId: string;
|
|
98
122
|
name: string;
|
|
123
|
+
description?: string;
|
|
124
|
+
clientUri?: string;
|
|
125
|
+
logoUri?: string;
|
|
126
|
+
privacyPolicyUrl?: string;
|
|
127
|
+
termsUrl?: string;
|
|
128
|
+
contacts?: string[];
|
|
99
129
|
enabled?: boolean;
|
|
100
|
-
internal?: boolean;
|
|
101
130
|
redirectUris?: string[];
|
|
102
131
|
type?: string;
|
|
132
|
+
deviceFlow?: boolean;
|
|
103
133
|
}): Promise<Models.App>;
|
|
104
134
|
/**
|
|
105
135
|
* Update an application by its unique ID.
|
|
106
136
|
*
|
|
107
137
|
* @param {string} appId - Application unique ID.
|
|
108
138
|
* @param {string} name - Application name.
|
|
139
|
+
* @param {string} description - Application description shown to users during OAuth2 consent.
|
|
140
|
+
* @param {string} clientUri - Application homepage URL shown to users during OAuth2 consent.
|
|
141
|
+
* @param {string} logoUri - Application logo URL shown to users during OAuth2 consent.
|
|
142
|
+
* @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
143
|
+
* @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
144
|
+
* @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
109
145
|
* @param {boolean} enabled - Is application enabled?
|
|
110
|
-
* @param {boolean} internal - When true, the application is restricted to the owner user or members of the configured team. Defaults to false (any user in the project can authorize).
|
|
111
146
|
* @param {string[]} redirectUris - Redirect URIs (array of valid URLs).
|
|
112
147
|
* @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`.
|
|
148
|
+
* @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.
|
|
113
149
|
* @throws {AppwriteException}
|
|
114
150
|
* @returns {Promise<Models.App>}
|
|
115
151
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
116
152
|
*/
|
|
117
|
-
update(appId: string, name: string,
|
|
153
|
+
update(appId: string, name: string, description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], enabled?: boolean, redirectUris?: string[], type?: string, deviceFlow?: boolean): Promise<Models.App>;
|
|
118
154
|
/**
|
|
119
155
|
* Delete an application by its unique ID.
|
|
120
156
|
*
|