@appwrite.io/console 15.0.0 → 15.1.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 +32 -17
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +32 -17
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +32 -17
- package/package.json +1 -1
- package/types/models.d.ts +44 -31
- package/types/services/compute.d.ts +2 -2
- package/types/services/databases.d.ts +14 -0
- package/types/services/oauth-2.d.ts +12 -3
- package/types/services/usage.d.ts +22 -22
package/dist/iife/sdk.js
CHANGED
|
@@ -4420,7 +4420,7 @@
|
|
|
4420
4420
|
'x-sdk-name': 'Console',
|
|
4421
4421
|
'x-sdk-platform': 'console',
|
|
4422
4422
|
'x-sdk-language': 'web',
|
|
4423
|
-
'x-sdk-version': '15.
|
|
4423
|
+
'x-sdk-version': '15.1.0',
|
|
4424
4424
|
'X-Appwrite-Response-Format': '1.9.5',
|
|
4425
4425
|
};
|
|
4426
4426
|
this.realtime = {
|
|
@@ -9728,7 +9728,7 @@
|
|
|
9728
9728
|
if (typeof sql === 'undefined') {
|
|
9729
9729
|
throw new AppwriteException('Missing required parameter: "sql"');
|
|
9730
9730
|
}
|
|
9731
|
-
const apiPath = '/compute/databases/{databaseId}/
|
|
9731
|
+
const apiPath = '/compute/databases/{databaseId}/executions'.replace('{databaseId}', encodeURIComponent(String(databaseId)));
|
|
9732
9732
|
const payload = {};
|
|
9733
9733
|
if (typeof sql !== 'undefined') {
|
|
9734
9734
|
payload['sql'] = sql;
|
|
@@ -24133,7 +24133,8 @@
|
|
|
24133
24133
|
codeChallengeMethod: rest[6],
|
|
24134
24134
|
prompt: rest[7],
|
|
24135
24135
|
maxAge: rest[8],
|
|
24136
|
-
authorizationDetails: rest[9]
|
|
24136
|
+
authorizationDetails: rest[9],
|
|
24137
|
+
resource: rest[10]
|
|
24137
24138
|
};
|
|
24138
24139
|
}
|
|
24139
24140
|
const clientId = params.clientId;
|
|
@@ -24147,6 +24148,7 @@
|
|
|
24147
24148
|
const prompt = params.prompt;
|
|
24148
24149
|
const maxAge = params.maxAge;
|
|
24149
24150
|
const authorizationDetails = params.authorizationDetails;
|
|
24151
|
+
const resource = params.resource;
|
|
24150
24152
|
if (typeof clientId === 'undefined') {
|
|
24151
24153
|
throw new AppwriteException('Missing required parameter: "clientId"');
|
|
24152
24154
|
}
|
|
@@ -24194,6 +24196,9 @@
|
|
|
24194
24196
|
if (typeof authorizationDetails !== 'undefined') {
|
|
24195
24197
|
payload['authorization_details'] = authorizationDetails;
|
|
24196
24198
|
}
|
|
24199
|
+
if (typeof resource !== 'undefined') {
|
|
24200
|
+
payload['resource'] = resource;
|
|
24201
|
+
}
|
|
24197
24202
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
24198
24203
|
const apiHeaders = {
|
|
24199
24204
|
'accept': 'application/json',
|
|
@@ -24209,12 +24214,14 @@
|
|
|
24209
24214
|
params = {
|
|
24210
24215
|
clientId: paramsOrFirst,
|
|
24211
24216
|
scope: rest[0],
|
|
24212
|
-
authorizationDetails: rest[1]
|
|
24217
|
+
authorizationDetails: rest[1],
|
|
24218
|
+
resource: rest[2]
|
|
24213
24219
|
};
|
|
24214
24220
|
}
|
|
24215
24221
|
const clientId = params.clientId;
|
|
24216
24222
|
const scope = params.scope;
|
|
24217
24223
|
const authorizationDetails = params.authorizationDetails;
|
|
24224
|
+
const resource = params.resource;
|
|
24218
24225
|
const apiPath = '/oauth2/{project_id}/device_authorization'.replace('{project_id}', encodeURIComponent(String(this.client.config.project)));
|
|
24219
24226
|
const payload = {};
|
|
24220
24227
|
if (typeof clientId !== 'undefined') {
|
|
@@ -24226,6 +24233,9 @@
|
|
|
24226
24233
|
if (typeof authorizationDetails !== 'undefined') {
|
|
24227
24234
|
payload['authorization_details'] = authorizationDetails;
|
|
24228
24235
|
}
|
|
24236
|
+
if (typeof resource !== 'undefined') {
|
|
24237
|
+
payload['resource'] = resource;
|
|
24238
|
+
}
|
|
24229
24239
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
24230
24240
|
const apiHeaders = {
|
|
24231
24241
|
'content-type': 'application/json',
|
|
@@ -24409,7 +24419,8 @@
|
|
|
24409
24419
|
clientId: rest[3],
|
|
24410
24420
|
clientSecret: rest[4],
|
|
24411
24421
|
codeVerifier: rest[5],
|
|
24412
|
-
redirectUri: rest[6]
|
|
24422
|
+
redirectUri: rest[6],
|
|
24423
|
+
resource: rest[7]
|
|
24413
24424
|
};
|
|
24414
24425
|
}
|
|
24415
24426
|
const grantType = params.grantType;
|
|
@@ -24420,6 +24431,7 @@
|
|
|
24420
24431
|
const clientSecret = params.clientSecret;
|
|
24421
24432
|
const codeVerifier = params.codeVerifier;
|
|
24422
24433
|
const redirectUri = params.redirectUri;
|
|
24434
|
+
const resource = params.resource;
|
|
24423
24435
|
if (typeof grantType === 'undefined') {
|
|
24424
24436
|
throw new AppwriteException('Missing required parameter: "grantType"');
|
|
24425
24437
|
}
|
|
@@ -24449,6 +24461,9 @@
|
|
|
24449
24461
|
if (typeof redirectUri !== 'undefined') {
|
|
24450
24462
|
payload['redirect_uri'] = redirectUri;
|
|
24451
24463
|
}
|
|
24464
|
+
if (typeof resource !== 'undefined') {
|
|
24465
|
+
payload['resource'] = resource;
|
|
24466
|
+
}
|
|
24452
24467
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
24453
24468
|
const apiHeaders = {
|
|
24454
24469
|
'content-type': 'application/json',
|
|
@@ -36776,7 +36791,7 @@
|
|
|
36776
36791
|
}
|
|
36777
36792
|
else {
|
|
36778
36793
|
params = {
|
|
36779
|
-
|
|
36794
|
+
metrics: paramsOrFirst,
|
|
36780
36795
|
resource: rest[0],
|
|
36781
36796
|
resourceId: rest[1],
|
|
36782
36797
|
interval: rest[2],
|
|
@@ -36789,7 +36804,7 @@
|
|
|
36789
36804
|
offset: rest[9]
|
|
36790
36805
|
};
|
|
36791
36806
|
}
|
|
36792
|
-
const
|
|
36807
|
+
const metrics = params.metrics;
|
|
36793
36808
|
const resource = params.resource;
|
|
36794
36809
|
const resourceId = params.resourceId;
|
|
36795
36810
|
const interval = params.interval;
|
|
@@ -36800,13 +36815,13 @@
|
|
|
36800
36815
|
const orderDir = params.orderDir;
|
|
36801
36816
|
const limit = params.limit;
|
|
36802
36817
|
const offset = params.offset;
|
|
36803
|
-
if (typeof
|
|
36804
|
-
throw new AppwriteException('Missing required parameter: "
|
|
36818
|
+
if (typeof metrics === 'undefined') {
|
|
36819
|
+
throw new AppwriteException('Missing required parameter: "metrics"');
|
|
36805
36820
|
}
|
|
36806
36821
|
const apiPath = '/usage/events';
|
|
36807
36822
|
const payload = {};
|
|
36808
|
-
if (typeof
|
|
36809
|
-
payload['
|
|
36823
|
+
if (typeof metrics !== 'undefined') {
|
|
36824
|
+
payload['metrics'] = metrics;
|
|
36810
36825
|
}
|
|
36811
36826
|
if (typeof resource !== 'undefined') {
|
|
36812
36827
|
payload['resource'] = resource;
|
|
@@ -36852,7 +36867,7 @@
|
|
|
36852
36867
|
}
|
|
36853
36868
|
else {
|
|
36854
36869
|
params = {
|
|
36855
|
-
|
|
36870
|
+
metrics: paramsOrFirst,
|
|
36856
36871
|
resourceId: rest[0],
|
|
36857
36872
|
teamId: rest[1],
|
|
36858
36873
|
interval: rest[2],
|
|
@@ -36865,7 +36880,7 @@
|
|
|
36865
36880
|
offset: rest[9]
|
|
36866
36881
|
};
|
|
36867
36882
|
}
|
|
36868
|
-
const
|
|
36883
|
+
const metrics = params.metrics;
|
|
36869
36884
|
const resourceId = params.resourceId;
|
|
36870
36885
|
const teamId = params.teamId;
|
|
36871
36886
|
const interval = params.interval;
|
|
@@ -36876,13 +36891,13 @@
|
|
|
36876
36891
|
const orderDir = params.orderDir;
|
|
36877
36892
|
const limit = params.limit;
|
|
36878
36893
|
const offset = params.offset;
|
|
36879
|
-
if (typeof
|
|
36880
|
-
throw new AppwriteException('Missing required parameter: "
|
|
36894
|
+
if (typeof metrics === 'undefined') {
|
|
36895
|
+
throw new AppwriteException('Missing required parameter: "metrics"');
|
|
36881
36896
|
}
|
|
36882
36897
|
const apiPath = '/usage/gauges';
|
|
36883
36898
|
const payload = {};
|
|
36884
|
-
if (typeof
|
|
36885
|
-
payload['
|
|
36899
|
+
if (typeof metrics !== 'undefined') {
|
|
36900
|
+
payload['metrics'] = metrics;
|
|
36886
36901
|
}
|
|
36887
36902
|
if (typeof resourceId !== 'undefined') {
|
|
36888
36903
|
payload['resourceId'] = resourceId;
|
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": "15.
|
|
5
|
+
"version": "15.1.0",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
7
7
|
"main": "dist/cjs/sdk.js",
|
|
8
8
|
"exports": {
|
package/types/models.d.ts
CHANGED
|
@@ -5121,59 +5121,59 @@ export declare namespace Models {
|
|
|
5121
5121
|
/**
|
|
5122
5122
|
* OAuth2 server status
|
|
5123
5123
|
*/
|
|
5124
|
-
oAuth2ServerEnabled
|
|
5124
|
+
oAuth2ServerEnabled?: boolean;
|
|
5125
5125
|
/**
|
|
5126
5126
|
* OAuth2 server authorization URL
|
|
5127
5127
|
*/
|
|
5128
|
-
oAuth2ServerAuthorizationUrl
|
|
5128
|
+
oAuth2ServerAuthorizationUrl?: string;
|
|
5129
5129
|
/**
|
|
5130
5130
|
* OAuth2 server allowed scopes
|
|
5131
5131
|
*/
|
|
5132
|
-
oAuth2ServerScopes
|
|
5132
|
+
oAuth2ServerScopes?: string[];
|
|
5133
5133
|
/**
|
|
5134
5134
|
* OAuth2 server accepted RFC 9396 authorization_details types
|
|
5135
5135
|
*/
|
|
5136
|
-
oAuth2ServerAuthorizationDetailsTypes
|
|
5136
|
+
oAuth2ServerAuthorizationDetailsTypes?: string[];
|
|
5137
5137
|
/**
|
|
5138
5138
|
* OAuth2 server access token duration in seconds for confidential clients
|
|
5139
5139
|
*/
|
|
5140
|
-
oAuth2ServerAccessTokenDuration
|
|
5140
|
+
oAuth2ServerAccessTokenDuration?: number;
|
|
5141
5141
|
/**
|
|
5142
5142
|
* OAuth2 server refresh token duration in seconds for confidential clients
|
|
5143
5143
|
*/
|
|
5144
|
-
oAuth2ServerRefreshTokenDuration
|
|
5144
|
+
oAuth2ServerRefreshTokenDuration?: number;
|
|
5145
5145
|
/**
|
|
5146
5146
|
* OAuth2 server access token duration in seconds for public clients (SPAs, mobile, native)
|
|
5147
5147
|
*/
|
|
5148
|
-
oAuth2ServerPublicAccessTokenDuration
|
|
5148
|
+
oAuth2ServerPublicAccessTokenDuration?: number;
|
|
5149
5149
|
/**
|
|
5150
5150
|
* OAuth2 server refresh token duration in seconds for public clients (SPAs, mobile, native)
|
|
5151
5151
|
*/
|
|
5152
|
-
oAuth2ServerPublicRefreshTokenDuration
|
|
5152
|
+
oAuth2ServerPublicRefreshTokenDuration?: number;
|
|
5153
5153
|
/**
|
|
5154
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.
|
|
5155
5155
|
*/
|
|
5156
|
-
oAuth2ServerConfidentialPkce
|
|
5156
|
+
oAuth2ServerConfidentialPkce?: boolean;
|
|
5157
5157
|
/**
|
|
5158
5158
|
* URL to your application page where users enter the device flow user code. Empty when the Device Authorization Grant is not configured.
|
|
5159
5159
|
*/
|
|
5160
|
-
oAuth2ServerVerificationUrl
|
|
5160
|
+
oAuth2ServerVerificationUrl?: string;
|
|
5161
5161
|
/**
|
|
5162
5162
|
* Number of characters in the device flow user code, excluding the formatting separator.
|
|
5163
5163
|
*/
|
|
5164
|
-
oAuth2ServerUserCodeLength
|
|
5164
|
+
oAuth2ServerUserCodeLength?: number;
|
|
5165
5165
|
/**
|
|
5166
5166
|
* Character set for device flow user codes: `numeric`, `alphabetic`, or `alphanumeric`.
|
|
5167
5167
|
*/
|
|
5168
|
-
oAuth2ServerUserCodeFormat
|
|
5168
|
+
oAuth2ServerUserCodeFormat?: string;
|
|
5169
5169
|
/**
|
|
5170
5170
|
* Lifetime in seconds of device flow device codes and user codes.
|
|
5171
5171
|
*/
|
|
5172
|
-
oAuth2ServerDeviceCodeDuration
|
|
5172
|
+
oAuth2ServerDeviceCodeDuration?: number;
|
|
5173
5173
|
/**
|
|
5174
5174
|
* OAuth2 server discovery URL
|
|
5175
5175
|
*/
|
|
5176
|
-
oAuth2ServerDiscoveryUrl
|
|
5176
|
+
oAuth2ServerDiscoveryUrl?: string;
|
|
5177
5177
|
};
|
|
5178
5178
|
/**
|
|
5179
5179
|
* ProjectAuthMethod
|
|
@@ -12040,15 +12040,15 @@ export declare namespace Models {
|
|
|
12040
12040
|
credits: AdditionalResource;
|
|
12041
12041
|
};
|
|
12042
12042
|
/**
|
|
12043
|
-
*
|
|
12043
|
+
* usageDataPoint
|
|
12044
12044
|
*/
|
|
12045
|
-
export type
|
|
12045
|
+
export type UsageDataPoint = {
|
|
12046
12046
|
/**
|
|
12047
|
-
*
|
|
12047
|
+
* Bucket start timestamp (ISO 8601). When `interval` is omitted this is the request end time, marking the aggregate as-of moment.
|
|
12048
12048
|
*/
|
|
12049
12049
|
time: string;
|
|
12050
12050
|
/**
|
|
12051
|
-
* Aggregated value for the
|
|
12051
|
+
* Aggregated value for the bucket.
|
|
12052
12052
|
*/
|
|
12053
12053
|
value: number;
|
|
12054
12054
|
/**
|
|
@@ -12103,40 +12103,49 @@ export declare namespace Models {
|
|
|
12103
12103
|
* External resource ID when broken down by `resourceId`.
|
|
12104
12104
|
*/
|
|
12105
12105
|
resourceId?: string;
|
|
12106
|
+
/**
|
|
12107
|
+
* Resource type when broken down by `resource` (gauges only).
|
|
12108
|
+
*/
|
|
12109
|
+
resource?: string;
|
|
12106
12110
|
};
|
|
12107
12111
|
/**
|
|
12108
12112
|
* usageEventList
|
|
12109
12113
|
*/
|
|
12110
12114
|
export type UsageEventList = {
|
|
12111
12115
|
/**
|
|
12112
|
-
*
|
|
12113
|
-
*/
|
|
12114
|
-
metric: string;
|
|
12115
|
-
/**
|
|
12116
|
-
* Time interval size (1h or 1d).
|
|
12116
|
+
* Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
|
|
12117
12117
|
*/
|
|
12118
12118
|
interval: string;
|
|
12119
12119
|
/**
|
|
12120
|
-
*
|
|
12120
|
+
* One entry per requested metric, each carrying its own points[] time series (sums per bucket / dimension over time).
|
|
12121
12121
|
*/
|
|
12122
|
-
|
|
12122
|
+
metrics: UsageMetric[];
|
|
12123
12123
|
};
|
|
12124
12124
|
/**
|
|
12125
12125
|
* usageGaugeList
|
|
12126
12126
|
*/
|
|
12127
12127
|
export type UsageGaugeList = {
|
|
12128
12128
|
/**
|
|
12129
|
-
*
|
|
12129
|
+
* Time interval size (1h or 1d). Empty when the request omits `interval` — points then carry the request end time as their as-of marker.
|
|
12130
12130
|
*/
|
|
12131
|
-
|
|
12131
|
+
interval: string;
|
|
12132
12132
|
/**
|
|
12133
|
-
*
|
|
12133
|
+
* One entry per requested metric, each carrying its own points[] time series (latest-snapshot per bucket / dimension via argMax over time).
|
|
12134
12134
|
*/
|
|
12135
|
-
|
|
12135
|
+
metrics: UsageMetric[];
|
|
12136
|
+
};
|
|
12137
|
+
/**
|
|
12138
|
+
* usageMetric
|
|
12139
|
+
*/
|
|
12140
|
+
export type UsageMetric = {
|
|
12141
|
+
/**
|
|
12142
|
+
* Metric key this series describes.
|
|
12143
|
+
*/
|
|
12144
|
+
metric: string;
|
|
12136
12145
|
/**
|
|
12137
|
-
*
|
|
12146
|
+
* Data points for this metric, ordered by time ascending. With `interval`, each entry is one bucket; without, each entry is one row of the dimensional or aggregate breakdown.
|
|
12138
12147
|
*/
|
|
12139
|
-
|
|
12148
|
+
points: UsageDataPoint[];
|
|
12140
12149
|
};
|
|
12141
12150
|
/**
|
|
12142
12151
|
* Organization
|
|
@@ -12627,6 +12636,10 @@ export declare namespace Models {
|
|
|
12627
12636
|
* Requested OAuth2 scopes the user is being asked to consent to.
|
|
12628
12637
|
*/
|
|
12629
12638
|
scopes: string[];
|
|
12639
|
+
/**
|
|
12640
|
+
* Requested RFC 8707 resource indicators the user is being asked to consent to.
|
|
12641
|
+
*/
|
|
12642
|
+
resources: string[];
|
|
12630
12643
|
/**
|
|
12631
12644
|
* Requested authorization_details the user is being asked to consent to, as a JSON string. Each entry has a `type` plus project-defined fields.
|
|
12632
12645
|
*/
|
|
@@ -637,7 +637,7 @@ export declare class Compute {
|
|
|
637
637
|
*/
|
|
638
638
|
updateDatabaseCredentials(databaseId: string): Promise<Models.DedicatedDatabaseCredentials>;
|
|
639
639
|
/**
|
|
640
|
-
* Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https://db-{project}-{db}.{region}.appwrite.center/v1/sql/
|
|
640
|
+
* Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https://db-{project}-{db}.{region}.appwrite.center/v1/sql/executions` with an `X-Appwrite-Key` header — that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values — the API does not interpolate raw strings.
|
|
641
641
|
*
|
|
642
642
|
* @param {string} params.databaseId - Database ID.
|
|
643
643
|
* @param {string} params.sql - SQL statement to execute. Exactly one statement per request.
|
|
@@ -653,7 +653,7 @@ export declare class Compute {
|
|
|
653
653
|
timeoutSeconds?: number;
|
|
654
654
|
}): Promise<Models.DedicatedDatabaseExecution>;
|
|
655
655
|
/**
|
|
656
|
-
* Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https://db-{project}-{db}.{region}.appwrite.center/v1/sql/
|
|
656
|
+
* Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https://db-{project}-{db}.{region}.appwrite.center/v1/sql/executions` with an `X-Appwrite-Key` header — that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values — the API does not interpolate raw strings.
|
|
657
657
|
*
|
|
658
658
|
* @param {string} databaseId - Database ID.
|
|
659
659
|
* @param {string} sql - SQL statement to execute. Exactly one statement per request.
|
|
@@ -68,6 +68,7 @@ export declare class Databases {
|
|
|
68
68
|
* @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).
|
|
69
69
|
* @throws {AppwriteException}
|
|
70
70
|
* @returns {Promise<Models.TransactionList>}
|
|
71
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listTransactions` instead.
|
|
71
72
|
*/
|
|
72
73
|
listTransactions(params?: {
|
|
73
74
|
queries?: string[];
|
|
@@ -87,6 +88,7 @@ export declare class Databases {
|
|
|
87
88
|
* @param {number} params.ttl - Seconds before the transaction expires.
|
|
88
89
|
* @throws {AppwriteException}
|
|
89
90
|
* @returns {Promise<Models.Transaction>}
|
|
91
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createTransaction` instead.
|
|
90
92
|
*/
|
|
91
93
|
createTransaction(params?: {
|
|
92
94
|
ttl?: number;
|
|
@@ -106,6 +108,7 @@ export declare class Databases {
|
|
|
106
108
|
* @param {string} params.transactionId - Transaction ID.
|
|
107
109
|
* @throws {AppwriteException}
|
|
108
110
|
* @returns {Promise<Models.Transaction>}
|
|
111
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getTransaction` instead.
|
|
109
112
|
*/
|
|
110
113
|
getTransaction(params: {
|
|
111
114
|
transactionId: string;
|
|
@@ -127,6 +130,7 @@ export declare class Databases {
|
|
|
127
130
|
* @param {boolean} params.rollback - Rollback transaction?
|
|
128
131
|
* @throws {AppwriteException}
|
|
129
132
|
* @returns {Promise<Models.Transaction>}
|
|
133
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTransaction` instead.
|
|
130
134
|
*/
|
|
131
135
|
updateTransaction(params: {
|
|
132
136
|
transactionId: string;
|
|
@@ -150,6 +154,7 @@ export declare class Databases {
|
|
|
150
154
|
* @param {string} params.transactionId - Transaction ID.
|
|
151
155
|
* @throws {AppwriteException}
|
|
152
156
|
* @returns {Promise<{}>}
|
|
157
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.deleteTransaction` instead.
|
|
153
158
|
*/
|
|
154
159
|
deleteTransaction(params: {
|
|
155
160
|
transactionId: string;
|
|
@@ -170,6 +175,7 @@ export declare class Databases {
|
|
|
170
175
|
* @param {object[]} params.operations - Array of staged operations.
|
|
171
176
|
* @throws {AppwriteException}
|
|
172
177
|
* @returns {Promise<Models.Transaction>}
|
|
178
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createOperations` instead.
|
|
173
179
|
*/
|
|
174
180
|
createOperations(params: {
|
|
175
181
|
transactionId: string;
|
|
@@ -1162,6 +1168,7 @@ export declare class Databases {
|
|
|
1162
1168
|
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1163
1169
|
* @throws {AppwriteException}
|
|
1164
1170
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1171
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createLongtextColumn` instead.
|
|
1165
1172
|
*/
|
|
1166
1173
|
createLongtextAttribute(params: {
|
|
1167
1174
|
databaseId: string;
|
|
@@ -1200,6 +1207,7 @@ export declare class Databases {
|
|
|
1200
1207
|
* @param {string} params.newKey - New Attribute Key.
|
|
1201
1208
|
* @throws {AppwriteException}
|
|
1202
1209
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1210
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateLongtextColumn` instead.
|
|
1203
1211
|
*/
|
|
1204
1212
|
updateLongtextAttribute(params: {
|
|
1205
1213
|
databaseId: string;
|
|
@@ -1237,6 +1245,7 @@ export declare class Databases {
|
|
|
1237
1245
|
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1238
1246
|
* @throws {AppwriteException}
|
|
1239
1247
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1248
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createMediumtextColumn` instead.
|
|
1240
1249
|
*/
|
|
1241
1250
|
createMediumtextAttribute(params: {
|
|
1242
1251
|
databaseId: string;
|
|
@@ -1275,6 +1284,7 @@ export declare class Databases {
|
|
|
1275
1284
|
* @param {string} params.newKey - New Attribute Key.
|
|
1276
1285
|
* @throws {AppwriteException}
|
|
1277
1286
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1287
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateMediumtextColumn` instead.
|
|
1278
1288
|
*/
|
|
1279
1289
|
updateMediumtextAttribute(params: {
|
|
1280
1290
|
databaseId: string;
|
|
@@ -1606,6 +1616,7 @@ export declare class Databases {
|
|
|
1606
1616
|
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1607
1617
|
* @throws {AppwriteException}
|
|
1608
1618
|
* @returns {Promise<Models.AttributeText>}
|
|
1619
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createTextColumn` instead.
|
|
1609
1620
|
*/
|
|
1610
1621
|
createTextAttribute(params: {
|
|
1611
1622
|
databaseId: string;
|
|
@@ -1644,6 +1655,7 @@ export declare class Databases {
|
|
|
1644
1655
|
* @param {string} params.newKey - New Attribute Key.
|
|
1645
1656
|
* @throws {AppwriteException}
|
|
1646
1657
|
* @returns {Promise<Models.AttributeText>}
|
|
1658
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
|
|
1647
1659
|
*/
|
|
1648
1660
|
updateTextAttribute(params: {
|
|
1649
1661
|
databaseId: string;
|
|
@@ -1756,6 +1768,7 @@ export declare class Databases {
|
|
|
1756
1768
|
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1757
1769
|
* @throws {AppwriteException}
|
|
1758
1770
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1771
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createVarcharColumn` instead.
|
|
1759
1772
|
*/
|
|
1760
1773
|
createVarcharAttribute(params: {
|
|
1761
1774
|
databaseId: string;
|
|
@@ -1797,6 +1810,7 @@ export declare class Databases {
|
|
|
1797
1810
|
* @param {string} params.newKey - New Attribute Key.
|
|
1798
1811
|
* @throws {AppwriteException}
|
|
1799
1812
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1813
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateVarcharColumn` instead.
|
|
1800
1814
|
*/
|
|
1801
1815
|
updateVarcharAttribute(params: {
|
|
1802
1816
|
databaseId: string;
|
|
@@ -39,6 +39,7 @@ export declare class Oauth2 {
|
|
|
39
39
|
* @param {string} params.prompt - OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.
|
|
40
40
|
* @param {number} params.maxAge - OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.
|
|
41
41
|
* @param {string} params.authorizationDetails - Rich authorization request. JSON array of objects, each with a `type` and project-defined fields
|
|
42
|
+
* @param {string} params.resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
42
43
|
* @throws {AppwriteException}
|
|
43
44
|
* @returns {Promise<Models.Oauth2Authorize>}
|
|
44
45
|
*/
|
|
@@ -54,6 +55,7 @@ export declare class Oauth2 {
|
|
|
54
55
|
prompt?: string;
|
|
55
56
|
maxAge?: number;
|
|
56
57
|
authorizationDetails?: string;
|
|
58
|
+
resource?: string;
|
|
57
59
|
}): Promise<Models.Oauth2Authorize>;
|
|
58
60
|
/**
|
|
59
61
|
* Begin the OAuth2 authorization flow. When called without a session, the user is redirected to the consent screen without grant ID. When called with a session, the redirect URL includes param for grant ID. You can pass Accept header of `application/json` to receive a JSON response instead of a redirect.
|
|
@@ -69,17 +71,19 @@ export declare class Oauth2 {
|
|
|
69
71
|
* @param {string} prompt - OIDC prompt parameter for customization of consent screen. Space-separated list of: none, login, consent, select_account.
|
|
70
72
|
* @param {number} maxAge - OIDC max_age paraleter for customization of consent screen. Maximum allowable elapsed time in seconds since the user last authenticated. If exceeded, re-authentication is required.
|
|
71
73
|
* @param {string} authorizationDetails - Rich authorization request. JSON array of objects, each with a `type` and project-defined fields
|
|
74
|
+
* @param {string} resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
72
75
|
* @throws {AppwriteException}
|
|
73
76
|
* @returns {Promise<Models.Oauth2Authorize>}
|
|
74
77
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
75
78
|
*/
|
|
76
|
-
authorize(clientId: string, redirectUri: string, responseType: string, scope: string, state?: string, nonce?: string, codeChallenge?: string, codeChallengeMethod?: string, prompt?: string, maxAge?: number, authorizationDetails?: string): Promise<Models.Oauth2Authorize>;
|
|
79
|
+
authorize(clientId: string, redirectUri: string, responseType: string, scope: string, state?: string, nonce?: string, codeChallenge?: string, codeChallengeMethod?: string, prompt?: string, maxAge?: number, authorizationDetails?: string, resource?: string): Promise<Models.Oauth2Authorize>;
|
|
77
80
|
/**
|
|
78
81
|
* Start the OAuth2 Device Authorization Grant. Returns the device code, user code, verification URL, expiration, and polling interval.
|
|
79
82
|
*
|
|
80
83
|
* @param {string} params.clientId - OAuth2 client ID.
|
|
81
84
|
* @param {string} params.scope - Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.
|
|
82
85
|
* @param {string} params.authorizationDetails - Rich authorization request. JSON array of objects, each with a `type` and project-defined fields
|
|
86
|
+
* @param {string} params.resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
83
87
|
* @throws {AppwriteException}
|
|
84
88
|
* @returns {Promise<Models.Oauth2DeviceAuthorization>}
|
|
85
89
|
*/
|
|
@@ -87,6 +91,7 @@ export declare class Oauth2 {
|
|
|
87
91
|
clientId?: string;
|
|
88
92
|
scope?: string;
|
|
89
93
|
authorizationDetails?: string;
|
|
94
|
+
resource?: string;
|
|
90
95
|
}): Promise<Models.Oauth2DeviceAuthorization>;
|
|
91
96
|
/**
|
|
92
97
|
* Start the OAuth2 Device Authorization Grant. Returns the device code, user code, verification URL, expiration, and polling interval.
|
|
@@ -94,11 +99,12 @@ export declare class Oauth2 {
|
|
|
94
99
|
* @param {string} clientId - OAuth2 client ID.
|
|
95
100
|
* @param {string} scope - Space-separated OAuth2 scopes. Can include project scopes, and built-in scopes: `openid`, `email`, `profile`.
|
|
96
101
|
* @param {string} authorizationDetails - Rich authorization request. JSON array of objects, each with a `type` and project-defined fields
|
|
102
|
+
* @param {string} resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
97
103
|
* @throws {AppwriteException}
|
|
98
104
|
* @returns {Promise<Models.Oauth2DeviceAuthorization>}
|
|
99
105
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
100
106
|
*/
|
|
101
|
-
createDeviceAuthorization(clientId?: string, scope?: string, authorizationDetails?: string): Promise<Models.Oauth2DeviceAuthorization>;
|
|
107
|
+
createDeviceAuthorization(clientId?: string, scope?: string, authorizationDetails?: string, resource?: string): Promise<Models.Oauth2DeviceAuthorization>;
|
|
102
108
|
/**
|
|
103
109
|
* Exchange a device flow user code for an OAuth2 grant. The authenticated user is bound to the pending grant. Pass the returned grant ID to the get grant endpoint to render the consent screen, then to the approve or reject endpoint to complete the flow.
|
|
104
110
|
*
|
|
@@ -229,6 +235,7 @@ export declare class Oauth2 {
|
|
|
229
235
|
* @param {string} params.clientSecret - OAuth2 client secret. Required for confidential apps.
|
|
230
236
|
* @param {string} params.codeVerifier - PKCE code verifier. Required for public apps.
|
|
231
237
|
* @param {string} params.redirectUri - Redirect URI. Required for `authorization_code` grant type.
|
|
238
|
+
* @param {string} params.resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
232
239
|
* @throws {AppwriteException}
|
|
233
240
|
* @returns {Promise<Models.Oauth2Token>}
|
|
234
241
|
*/
|
|
@@ -241,6 +248,7 @@ export declare class Oauth2 {
|
|
|
241
248
|
clientSecret?: string;
|
|
242
249
|
codeVerifier?: string;
|
|
243
250
|
redirectUri?: string;
|
|
251
|
+
resource?: string;
|
|
244
252
|
}): Promise<Models.Oauth2Token>;
|
|
245
253
|
/**
|
|
246
254
|
* Exchange an OAuth2 authorization code, refresh token, or device code for access and refresh tokens.
|
|
@@ -253,9 +261,10 @@ export declare class Oauth2 {
|
|
|
253
261
|
* @param {string} clientSecret - OAuth2 client secret. Required for confidential apps.
|
|
254
262
|
* @param {string} codeVerifier - PKCE code verifier. Required for public apps.
|
|
255
263
|
* @param {string} redirectUri - Redirect URI. Required for `authorization_code` grant type.
|
|
264
|
+
* @param {string} resource - RFC 8707 resource indicator URI or URI list. Each value must be an absolute URI without a fragment.
|
|
256
265
|
* @throws {AppwriteException}
|
|
257
266
|
* @returns {Promise<Models.Oauth2Token>}
|
|
258
267
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
259
268
|
*/
|
|
260
|
-
createToken(grantType: string, code?: string, refreshToken?: string, deviceCode?: string, clientId?: string, clientSecret?: string, codeVerifier?: string, redirectUri?: string): Promise<Models.Oauth2Token>;
|
|
269
|
+
createToken(grantType: string, code?: string, refreshToken?: string, deviceCode?: string, clientId?: string, clientSecret?: string, codeVerifier?: string, redirectUri?: string, resource?: string): Promise<Models.Oauth2Token>;
|
|
261
270
|
}
|