@appwrite.io/console 14.0.0 → 15.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 +1241 -636
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1241 -637
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1241 -636
- package/package.json +1 -1
- package/types/client.d.ts +15 -3
- package/types/enums/project-policy-id.d.ts +2 -1
- package/types/enums/project-service-id.d.ts +2 -1
- package/types/enums/query-suggestion-resource.d.ts +1 -0
- package/types/index.d.ts +1 -0
- package/types/models.d.ts +247 -61
- package/types/services/apps.d.ts +38 -2
- package/types/services/compute.d.ts +8 -8
- package/types/services/oauth-2.d.ts +261 -0
- package/types/services/project.d.ts +27 -8
- package/types/services/usage.d.ts +98 -20
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": "15.0.0",
|
|
6
6
|
"license": "BSD-3-Clause",
|
|
7
7
|
"main": "dist/cjs/sdk.js",
|
|
8
8
|
"exports": {
|
package/types/client.d.ts
CHANGED
|
@@ -121,6 +121,7 @@ declare class Client {
|
|
|
121
121
|
impersonateuserphone: string;
|
|
122
122
|
platform: string;
|
|
123
123
|
selfSigned: boolean;
|
|
124
|
+
credentials: RequestCredentials;
|
|
124
125
|
};
|
|
125
126
|
/**
|
|
126
127
|
* Custom headers for API requests.
|
|
@@ -161,6 +162,17 @@ declare class Client {
|
|
|
161
162
|
* @returns {this}
|
|
162
163
|
*/
|
|
163
164
|
setSelfSigned(selfSigned: boolean): this;
|
|
165
|
+
/**
|
|
166
|
+
* Set credentials
|
|
167
|
+
*
|
|
168
|
+
* Controls whether fetch sends credentials like cookies with requests.
|
|
169
|
+
*
|
|
170
|
+
* @param {RequestCredentials} credentials
|
|
171
|
+
*
|
|
172
|
+
* @returns {this}
|
|
173
|
+
*/
|
|
174
|
+
setCredentials(credentials: RequestCredentials): this;
|
|
175
|
+
private shouldUseFallbackCredentials;
|
|
164
176
|
/**
|
|
165
177
|
* Set Project
|
|
166
178
|
*
|
|
@@ -240,7 +252,7 @@ declare class Client {
|
|
|
240
252
|
/**
|
|
241
253
|
* Set ImpersonateUserId
|
|
242
254
|
*
|
|
243
|
-
* Impersonate a user by ID
|
|
255
|
+
* Impersonate a user by ID
|
|
244
256
|
*
|
|
245
257
|
* @param value string
|
|
246
258
|
*
|
|
@@ -250,7 +262,7 @@ declare class Client {
|
|
|
250
262
|
/**
|
|
251
263
|
* Set ImpersonateUserEmail
|
|
252
264
|
*
|
|
253
|
-
* Impersonate a user by email
|
|
265
|
+
* Impersonate a user by email
|
|
254
266
|
*
|
|
255
267
|
* @param value string
|
|
256
268
|
*
|
|
@@ -260,7 +272,7 @@ declare class Client {
|
|
|
260
272
|
/**
|
|
261
273
|
* Set ImpersonateUserPhone
|
|
262
274
|
*
|
|
263
|
-
* Impersonate a user by phone
|
|
275
|
+
* Impersonate a user by phone
|
|
264
276
|
*
|
|
265
277
|
* @param value string
|
|
266
278
|
*
|
|
@@ -11,5 +11,6 @@ export declare enum ProjectPolicyId {
|
|
|
11
11
|
Membershipprivacy = "membership-privacy",
|
|
12
12
|
Denyaliasedemail = "deny-aliased-email",
|
|
13
13
|
Denydisposableemail = "deny-disposable-email",
|
|
14
|
-
Denyfreeemail = "deny-free-email"
|
|
14
|
+
Denyfreeemail = "deny-free-email",
|
|
15
|
+
Denycorporateemail = "deny-corporate-email"
|
|
15
16
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ export { Locale } from './services/locale';
|
|
|
24
24
|
export { Manager } from './services/manager';
|
|
25
25
|
export { Messaging } from './services/messaging';
|
|
26
26
|
export { Migrations } from './services/migrations';
|
|
27
|
+
export { Oauth2 } from './services/oauth-2';
|
|
27
28
|
export { Organization } from './services/organization';
|
|
28
29
|
export { Organizations } from './services/organizations';
|
|
29
30
|
export { Presences } from './services/presences';
|
package/types/models.d.ts
CHANGED
|
@@ -564,7 +564,7 @@ export declare namespace Models {
|
|
|
564
564
|
/**
|
|
565
565
|
* List of policies.
|
|
566
566
|
*/
|
|
567
|
-
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail)[];
|
|
567
|
+
policies: (Models.PolicyPasswordDictionary | Models.PolicyPasswordHistory | Models.PolicyPasswordStrength | Models.PolicyPasswordPersonalData | Models.PolicySessionAlert | Models.PolicySessionDuration | Models.PolicySessionInvalidation | Models.PolicySessionLimit | Models.PolicyUserLimit | Models.PolicyMembershipPrivacy | Models.PolicyDenyAliasedEmail | Models.PolicyDenyDisposableEmail | Models.PolicyDenyFreeEmail | Models.PolicyDenyCorporateEmail)[];
|
|
568
568
|
};
|
|
569
569
|
/**
|
|
570
570
|
* Email Templates List
|
|
@@ -9744,6 +9744,10 @@ export declare namespace Models {
|
|
|
9744
9744
|
* Does plan support blocking free email addresses.
|
|
9745
9745
|
*/
|
|
9746
9746
|
supportsFreeEmailValidation: boolean;
|
|
9747
|
+
/**
|
|
9748
|
+
* Does plan support restricting sign-ups to corporate email addresses only.
|
|
9749
|
+
*/
|
|
9750
|
+
supportsCorporateEmailValidation: boolean;
|
|
9747
9751
|
/**
|
|
9748
9752
|
* Does plan support project-specific member roles.
|
|
9749
9753
|
*/
|
|
@@ -10321,7 +10325,7 @@ export declare namespace Models {
|
|
|
10321
10325
|
*/
|
|
10322
10326
|
storage: number;
|
|
10323
10327
|
/**
|
|
10324
|
-
* Storage class
|
|
10328
|
+
* Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.
|
|
10325
10329
|
*/
|
|
10326
10330
|
storageClass: string;
|
|
10327
10331
|
/**
|
|
@@ -10401,7 +10405,7 @@ export declare namespace Models {
|
|
|
10401
10405
|
*/
|
|
10402
10406
|
sqlApiEnabled: boolean;
|
|
10403
10407
|
/**
|
|
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.
|
|
10408
|
+
* Statement types accepted by the SQL API. Defaults to read/write 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.
|
|
10405
10409
|
*/
|
|
10406
10410
|
sqlApiAllowedStatements: string[];
|
|
10407
10411
|
/**
|
|
@@ -11582,6 +11586,19 @@ export declare namespace Models {
|
|
|
11582
11586
|
*/
|
|
11583
11587
|
enabled: boolean;
|
|
11584
11588
|
};
|
|
11589
|
+
/**
|
|
11590
|
+
* Policy Deny Corporate Email
|
|
11591
|
+
*/
|
|
11592
|
+
export type PolicyDenyCorporateEmail = {
|
|
11593
|
+
/**
|
|
11594
|
+
* Policy ID.
|
|
11595
|
+
*/
|
|
11596
|
+
$id: string;
|
|
11597
|
+
/**
|
|
11598
|
+
* Whether the deny non-corporate email policy is enabled.
|
|
11599
|
+
*/
|
|
11600
|
+
enabled: boolean;
|
|
11601
|
+
};
|
|
11585
11602
|
/**
|
|
11586
11603
|
* PoolerConfig
|
|
11587
11604
|
*/
|
|
@@ -12023,74 +12040,103 @@ export declare namespace Models {
|
|
|
12023
12040
|
credits: AdditionalResource;
|
|
12024
12041
|
};
|
|
12025
12042
|
/**
|
|
12026
|
-
*
|
|
12043
|
+
* usageGroup
|
|
12027
12044
|
*/
|
|
12028
|
-
export type
|
|
12045
|
+
export type UsageGroup = {
|
|
12029
12046
|
/**
|
|
12030
|
-
*
|
|
12047
|
+
* Group start timestamp (ISO 8601).
|
|
12031
12048
|
*/
|
|
12032
|
-
|
|
12049
|
+
time: string;
|
|
12033
12050
|
/**
|
|
12034
|
-
*
|
|
12051
|
+
* Aggregated value for the group.
|
|
12035
12052
|
*/
|
|
12036
12053
|
value: number;
|
|
12037
12054
|
/**
|
|
12038
|
-
*
|
|
12055
|
+
* API endpoint path when broken down by `path`.
|
|
12039
12056
|
*/
|
|
12040
|
-
|
|
12057
|
+
path?: string;
|
|
12041
12058
|
/**
|
|
12042
|
-
*
|
|
12059
|
+
* HTTP method when broken down by `method`.
|
|
12043
12060
|
*/
|
|
12044
|
-
|
|
12061
|
+
method?: string;
|
|
12045
12062
|
/**
|
|
12046
|
-
*
|
|
12063
|
+
* HTTP status code when broken down by `status`.
|
|
12047
12064
|
*/
|
|
12048
|
-
|
|
12065
|
+
status?: string;
|
|
12049
12066
|
/**
|
|
12050
|
-
*
|
|
12067
|
+
* API service segment when broken down by `service`.
|
|
12051
12068
|
*/
|
|
12052
|
-
|
|
12069
|
+
service?: string;
|
|
12053
12070
|
/**
|
|
12054
|
-
*
|
|
12071
|
+
* Country code when broken down by `country`.
|
|
12055
12072
|
*/
|
|
12056
|
-
|
|
12073
|
+
country?: string;
|
|
12057
12074
|
/**
|
|
12058
|
-
*
|
|
12075
|
+
* Appwrite region when broken down by `region`.
|
|
12059
12076
|
*/
|
|
12060
|
-
|
|
12077
|
+
region?: string;
|
|
12061
12078
|
/**
|
|
12062
|
-
*
|
|
12079
|
+
* Caller origin hostname when broken down by `hostname`.
|
|
12063
12080
|
*/
|
|
12064
|
-
|
|
12081
|
+
hostname?: string;
|
|
12065
12082
|
/**
|
|
12066
|
-
*
|
|
12083
|
+
* Operating system name when broken down by `osName`.
|
|
12067
12084
|
*/
|
|
12068
|
-
|
|
12085
|
+
osName?: string;
|
|
12086
|
+
/**
|
|
12087
|
+
* Client type when broken down by `clientType`.
|
|
12088
|
+
*/
|
|
12089
|
+
clientType?: string;
|
|
12090
|
+
/**
|
|
12091
|
+
* Client name when broken down by `clientName`.
|
|
12092
|
+
*/
|
|
12093
|
+
clientName?: string;
|
|
12094
|
+
/**
|
|
12095
|
+
* Device classification when broken down by `deviceName`.
|
|
12096
|
+
*/
|
|
12097
|
+
deviceName?: string;
|
|
12098
|
+
/**
|
|
12099
|
+
* Owning team ID when broken down by `teamId`.
|
|
12100
|
+
*/
|
|
12101
|
+
teamId?: string;
|
|
12102
|
+
/**
|
|
12103
|
+
* External resource ID when broken down by `resourceId`.
|
|
12104
|
+
*/
|
|
12105
|
+
resourceId?: string;
|
|
12069
12106
|
};
|
|
12070
12107
|
/**
|
|
12071
|
-
*
|
|
12108
|
+
* usageEventList
|
|
12072
12109
|
*/
|
|
12073
|
-
export type
|
|
12110
|
+
export type UsageEventList = {
|
|
12074
12111
|
/**
|
|
12075
|
-
*
|
|
12112
|
+
* Metric key the groups describe.
|
|
12076
12113
|
*/
|
|
12077
12114
|
metric: string;
|
|
12078
12115
|
/**
|
|
12079
|
-
*
|
|
12116
|
+
* Time interval size (1h or 1d).
|
|
12080
12117
|
*/
|
|
12081
|
-
|
|
12118
|
+
interval: string;
|
|
12082
12119
|
/**
|
|
12083
|
-
*
|
|
12120
|
+
* Aggregated groups ordered by time ascending.
|
|
12084
12121
|
*/
|
|
12085
|
-
|
|
12122
|
+
groups: UsageGroup[];
|
|
12123
|
+
};
|
|
12124
|
+
/**
|
|
12125
|
+
* usageGaugeList
|
|
12126
|
+
*/
|
|
12127
|
+
export type UsageGaugeList = {
|
|
12086
12128
|
/**
|
|
12087
|
-
*
|
|
12129
|
+
* Metric key the groups describe.
|
|
12088
12130
|
*/
|
|
12089
|
-
|
|
12131
|
+
metric: string;
|
|
12090
12132
|
/**
|
|
12091
|
-
*
|
|
12133
|
+
* Time interval size (1h or 1d).
|
|
12092
12134
|
*/
|
|
12093
|
-
|
|
12135
|
+
interval: string;
|
|
12136
|
+
/**
|
|
12137
|
+
* Aggregated groups ordered by time ascending. Each group carries the latest snapshot in its interval (argMax over time).
|
|
12138
|
+
*/
|
|
12139
|
+
groups: UsageGroup[];
|
|
12094
12140
|
};
|
|
12095
12141
|
/**
|
|
12096
12142
|
* Organization
|
|
@@ -12387,10 +12433,34 @@ export declare namespace Models {
|
|
|
12387
12433
|
* Application support or security contact emails.
|
|
12388
12434
|
*/
|
|
12389
12435
|
contacts: string[];
|
|
12436
|
+
/**
|
|
12437
|
+
* Application tagline shown to users during OAuth2 consent.
|
|
12438
|
+
*/
|
|
12439
|
+
tagline: string;
|
|
12440
|
+
/**
|
|
12441
|
+
* Application tags shown to users during OAuth2 consent.
|
|
12442
|
+
*/
|
|
12443
|
+
tags: string[];
|
|
12444
|
+
/**
|
|
12445
|
+
* Application image URLs shown to users during OAuth2 consent.
|
|
12446
|
+
*/
|
|
12447
|
+
images: string[];
|
|
12448
|
+
/**
|
|
12449
|
+
* Application support URL shown to users during OAuth2 consent.
|
|
12450
|
+
*/
|
|
12451
|
+
supportUrl: string;
|
|
12452
|
+
/**
|
|
12453
|
+
* Application data deletion URL shown to users during OAuth2 consent.
|
|
12454
|
+
*/
|
|
12455
|
+
dataDeletionUrl: string;
|
|
12390
12456
|
/**
|
|
12391
12457
|
* List of authorized redirect URIs. These URIs can be used to redirect users after they authenticate.
|
|
12392
12458
|
*/
|
|
12393
12459
|
redirectUris: string[];
|
|
12460
|
+
/**
|
|
12461
|
+
* List of authorized post-logout redirect URIs for OpenID Connect RP-Initiated Logout. The logout endpoint only redirects users to URIs in this list after ending their session.
|
|
12462
|
+
*/
|
|
12463
|
+
postLogoutRedirectUris: string[];
|
|
12394
12464
|
/**
|
|
12395
12465
|
* Whether the app is enabled or not.
|
|
12396
12466
|
*/
|
|
@@ -12498,6 +12568,148 @@ export declare namespace Models {
|
|
|
12498
12568
|
*/
|
|
12499
12569
|
lastAccessedAt?: string;
|
|
12500
12570
|
};
|
|
12571
|
+
/**
|
|
12572
|
+
* OAuth2 Authorize
|
|
12573
|
+
*/
|
|
12574
|
+
export type Oauth2Authorize = {
|
|
12575
|
+
/**
|
|
12576
|
+
* OAuth2 grant ID. Set when the user must give explicit consent; pass it to the approve or reject endpoint. Empty when a redirect URL is returned instead.
|
|
12577
|
+
*/
|
|
12578
|
+
grantId: string;
|
|
12579
|
+
/**
|
|
12580
|
+
* URL the end user should be redirected to when the flow can complete without consent. Empty when consent is still required.
|
|
12581
|
+
*/
|
|
12582
|
+
redirectUrl: string;
|
|
12583
|
+
};
|
|
12584
|
+
/**
|
|
12585
|
+
* OAuth2 Approve
|
|
12586
|
+
*/
|
|
12587
|
+
export type Oauth2Approve = {
|
|
12588
|
+
/**
|
|
12589
|
+
* URL the end user should be redirected to after the grant is approved, carrying the authorization `code` and/or `id_token` along with the original `state`.
|
|
12590
|
+
*/
|
|
12591
|
+
redirectUrl: string;
|
|
12592
|
+
};
|
|
12593
|
+
/**
|
|
12594
|
+
* OAuth2 Reject
|
|
12595
|
+
*/
|
|
12596
|
+
export type Oauth2Reject = {
|
|
12597
|
+
/**
|
|
12598
|
+
* URL the end user should be redirected to after the grant is rejected, carrying an `access_denied` error.
|
|
12599
|
+
*/
|
|
12600
|
+
redirectUrl: string;
|
|
12601
|
+
};
|
|
12602
|
+
/**
|
|
12603
|
+
* OAuth2 Grant
|
|
12604
|
+
*/
|
|
12605
|
+
export type Oauth2Grant = {
|
|
12606
|
+
/**
|
|
12607
|
+
* Grant ID.
|
|
12608
|
+
*/
|
|
12609
|
+
$id: string;
|
|
12610
|
+
/**
|
|
12611
|
+
* Grant creation time in ISO 8601 format.
|
|
12612
|
+
*/
|
|
12613
|
+
$createdAt: string;
|
|
12614
|
+
/**
|
|
12615
|
+
* Grant update date in ISO 8601 format.
|
|
12616
|
+
*/
|
|
12617
|
+
$updatedAt: string;
|
|
12618
|
+
/**
|
|
12619
|
+
* ID of the user the grant belongs to.
|
|
12620
|
+
*/
|
|
12621
|
+
userId: string;
|
|
12622
|
+
/**
|
|
12623
|
+
* ID of the OAuth2 client (app) the grant was requested for.
|
|
12624
|
+
*/
|
|
12625
|
+
appId: string;
|
|
12626
|
+
/**
|
|
12627
|
+
* Requested OAuth2 scopes the user is being asked to consent to.
|
|
12628
|
+
*/
|
|
12629
|
+
scopes: string[];
|
|
12630
|
+
/**
|
|
12631
|
+
* 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
|
+
*/
|
|
12633
|
+
authorizationDetails: string;
|
|
12634
|
+
/**
|
|
12635
|
+
* OIDC prompt directive the consent screen should honor. Space-separated list of: login, consent, select_account.
|
|
12636
|
+
*/
|
|
12637
|
+
prompt: string;
|
|
12638
|
+
/**
|
|
12639
|
+
* Redirect URI the user will be sent to after the flow completes.
|
|
12640
|
+
*/
|
|
12641
|
+
redirectUri: string;
|
|
12642
|
+
/**
|
|
12643
|
+
* Unix timestamp of when the user last authenticated.
|
|
12644
|
+
*/
|
|
12645
|
+
authTime: number;
|
|
12646
|
+
/**
|
|
12647
|
+
* Grant expiration time in ISO 8601 format.
|
|
12648
|
+
*/
|
|
12649
|
+
expire: string;
|
|
12650
|
+
};
|
|
12651
|
+
/**
|
|
12652
|
+
* OAuth2 Device Authorization
|
|
12653
|
+
*/
|
|
12654
|
+
export type Oauth2DeviceAuthorization = {
|
|
12655
|
+
/**
|
|
12656
|
+
* Device verification code used by the client to poll the token endpoint.
|
|
12657
|
+
*/
|
|
12658
|
+
device_code: string;
|
|
12659
|
+
/**
|
|
12660
|
+
* Short code the end user enters on the verification page.
|
|
12661
|
+
*/
|
|
12662
|
+
user_code: string;
|
|
12663
|
+
/**
|
|
12664
|
+
* URL where the end user enters the user code.
|
|
12665
|
+
*/
|
|
12666
|
+
verification_uri: string;
|
|
12667
|
+
/**
|
|
12668
|
+
* Verification URL with the user code prefilled as a query parameter.
|
|
12669
|
+
*/
|
|
12670
|
+
verification_uri_complete: string;
|
|
12671
|
+
/**
|
|
12672
|
+
* Lifetime of the device code and user code in seconds.
|
|
12673
|
+
*/
|
|
12674
|
+
expires_in: number;
|
|
12675
|
+
/**
|
|
12676
|
+
* Minimum polling interval for the token endpoint in seconds.
|
|
12677
|
+
*/
|
|
12678
|
+
interval: number;
|
|
12679
|
+
};
|
|
12680
|
+
/**
|
|
12681
|
+
* OAuth2 Token
|
|
12682
|
+
*/
|
|
12683
|
+
export type Oauth2Token = {
|
|
12684
|
+
/**
|
|
12685
|
+
* OAuth2 access token.
|
|
12686
|
+
*/
|
|
12687
|
+
access_token: string;
|
|
12688
|
+
/**
|
|
12689
|
+
* OAuth2 token type.
|
|
12690
|
+
*/
|
|
12691
|
+
token_type: string;
|
|
12692
|
+
/**
|
|
12693
|
+
* Access token lifetime in seconds.
|
|
12694
|
+
*/
|
|
12695
|
+
expires_in: number;
|
|
12696
|
+
/**
|
|
12697
|
+
* OAuth2 refresh token.
|
|
12698
|
+
*/
|
|
12699
|
+
refresh_token: string;
|
|
12700
|
+
/**
|
|
12701
|
+
* Space-separated scopes granted to the access token.
|
|
12702
|
+
*/
|
|
12703
|
+
scope: string;
|
|
12704
|
+
/**
|
|
12705
|
+
* Granted RFC 9396 authorization details as a JSON string.
|
|
12706
|
+
*/
|
|
12707
|
+
authorization_details?: string;
|
|
12708
|
+
/**
|
|
12709
|
+
* OpenID Connect ID token. Returned when the `openid` scope is granted.
|
|
12710
|
+
*/
|
|
12711
|
+
id_token?: string;
|
|
12712
|
+
};
|
|
12501
12713
|
/**
|
|
12502
12714
|
* Activity event list
|
|
12503
12715
|
*/
|
|
@@ -12745,32 +12957,6 @@ export declare namespace Models {
|
|
|
12745
12957
|
*/
|
|
12746
12958
|
regions: ConsoleRegion[];
|
|
12747
12959
|
};
|
|
12748
|
-
/**
|
|
12749
|
-
* Usage events list
|
|
12750
|
-
*/
|
|
12751
|
-
export type UsageEventList = {
|
|
12752
|
-
/**
|
|
12753
|
-
* Total number of events that matched your query.
|
|
12754
|
-
*/
|
|
12755
|
-
total: number;
|
|
12756
|
-
/**
|
|
12757
|
-
* List of events.
|
|
12758
|
-
*/
|
|
12759
|
-
events: UsageEvent[];
|
|
12760
|
-
};
|
|
12761
|
-
/**
|
|
12762
|
-
* Usage gauges list
|
|
12763
|
-
*/
|
|
12764
|
-
export type UsageGaugeList = {
|
|
12765
|
-
/**
|
|
12766
|
-
* Total number of gauges that matched your query.
|
|
12767
|
-
*/
|
|
12768
|
-
total: number;
|
|
12769
|
-
/**
|
|
12770
|
-
* List of gauges.
|
|
12771
|
-
*/
|
|
12772
|
-
gauges: UsageGauge[];
|
|
12773
|
-
};
|
|
12774
12960
|
/**
|
|
12775
12961
|
* Apps list
|
|
12776
12962
|
*/
|
package/types/services/apps.d.ts
CHANGED
|
@@ -37,6 +37,12 @@ export declare class Apps {
|
|
|
37
37
|
* @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
38
38
|
* @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
39
39
|
* @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
40
|
+
* @param {string} params.tagline - Application tagline shown to users during OAuth2 consent.
|
|
41
|
+
* @param {string[]} params.tags - Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.
|
|
42
|
+
* @param {string[]} params.images - Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.
|
|
43
|
+
* @param {string} params.supportUrl - Application support URL shown to users during OAuth2 consent.
|
|
44
|
+
* @param {string} params.dataDeletionUrl - Application data deletion URL shown to users during OAuth2 consent.
|
|
45
|
+
* @param {string[]} params.postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout (array of valid URLs). After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
40
46
|
* @param {boolean} params.enabled - Is application enabled?
|
|
41
47
|
* @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
48
|
* @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.
|
|
@@ -54,6 +60,12 @@ export declare class Apps {
|
|
|
54
60
|
privacyPolicyUrl?: string;
|
|
55
61
|
termsUrl?: string;
|
|
56
62
|
contacts?: string[];
|
|
63
|
+
tagline?: string;
|
|
64
|
+
tags?: string[];
|
|
65
|
+
images?: string[];
|
|
66
|
+
supportUrl?: string;
|
|
67
|
+
dataDeletionUrl?: string;
|
|
68
|
+
postLogoutRedirectUris?: string[];
|
|
57
69
|
enabled?: boolean;
|
|
58
70
|
type?: string;
|
|
59
71
|
deviceFlow?: boolean;
|
|
@@ -71,6 +83,12 @@ export declare class Apps {
|
|
|
71
83
|
* @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
72
84
|
* @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
73
85
|
* @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
86
|
+
* @param {string} tagline - Application tagline shown to users during OAuth2 consent.
|
|
87
|
+
* @param {string[]} tags - Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.
|
|
88
|
+
* @param {string[]} images - Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.
|
|
89
|
+
* @param {string} supportUrl - Application support URL shown to users during OAuth2 consent.
|
|
90
|
+
* @param {string} dataDeletionUrl - Application data deletion URL shown to users during OAuth2 consent.
|
|
91
|
+
* @param {string[]} postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout (array of valid URLs). After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
74
92
|
* @param {boolean} enabled - Is application enabled?
|
|
75
93
|
* @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
94
|
* @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.
|
|
@@ -79,7 +97,7 @@ export declare class Apps {
|
|
|
79
97
|
* @returns {Promise<Models.App>}
|
|
80
98
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
81
99
|
*/
|
|
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>;
|
|
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>;
|
|
83
101
|
/**
|
|
84
102
|
* Get an application by its unique ID.
|
|
85
103
|
*
|
|
@@ -110,8 +128,14 @@ export declare class Apps {
|
|
|
110
128
|
* @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
111
129
|
* @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
112
130
|
* @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
131
|
+
* @param {string} params.tagline - Application tagline shown to users during OAuth2 consent.
|
|
132
|
+
* @param {string[]} params.tags - Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.
|
|
133
|
+
* @param {string[]} params.images - Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.
|
|
134
|
+
* @param {string} params.supportUrl - Application support URL shown to users during OAuth2 consent.
|
|
135
|
+
* @param {string} params.dataDeletionUrl - Application data deletion URL shown to users during OAuth2 consent.
|
|
113
136
|
* @param {boolean} params.enabled - Is application enabled?
|
|
114
137
|
* @param {string[]} params.redirectUris - Redirect URIs (array of valid URLs).
|
|
138
|
+
* @param {string[]} params.postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout (array of valid URLs). After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
115
139
|
* @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
140
|
* @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.
|
|
117
141
|
* @throws {AppwriteException}
|
|
@@ -126,8 +150,14 @@ export declare class Apps {
|
|
|
126
150
|
privacyPolicyUrl?: string;
|
|
127
151
|
termsUrl?: string;
|
|
128
152
|
contacts?: string[];
|
|
153
|
+
tagline?: string;
|
|
154
|
+
tags?: string[];
|
|
155
|
+
images?: string[];
|
|
156
|
+
supportUrl?: string;
|
|
157
|
+
dataDeletionUrl?: string;
|
|
129
158
|
enabled?: boolean;
|
|
130
159
|
redirectUris?: string[];
|
|
160
|
+
postLogoutRedirectUris?: string[];
|
|
131
161
|
type?: string;
|
|
132
162
|
deviceFlow?: boolean;
|
|
133
163
|
}): Promise<Models.App>;
|
|
@@ -142,15 +172,21 @@ export declare class Apps {
|
|
|
142
172
|
* @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
|
|
143
173
|
* @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
|
|
144
174
|
* @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
|
|
175
|
+
* @param {string} tagline - Application tagline shown to users during OAuth2 consent.
|
|
176
|
+
* @param {string[]} tags - Application tags shown to users during OAuth2 consent. Maximum of 100 tags are allowed, each up to 64 characters long.
|
|
177
|
+
* @param {string[]} images - Application image URLs shown to users during OAuth2 consent. Maximum of 100 images are allowed.
|
|
178
|
+
* @param {string} supportUrl - Application support URL shown to users during OAuth2 consent.
|
|
179
|
+
* @param {string} dataDeletionUrl - Application data deletion URL shown to users during OAuth2 consent.
|
|
145
180
|
* @param {boolean} enabled - Is application enabled?
|
|
146
181
|
* @param {string[]} redirectUris - Redirect URIs (array of valid URLs).
|
|
182
|
+
* @param {string[]} postLogoutRedirectUris - Post-logout redirect URIs for OpenID Connect RP-Initiated Logout (array of valid URLs). After ending the user session, the logout endpoint only redirects to URIs in this list.
|
|
147
183
|
* @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
184
|
* @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.
|
|
149
185
|
* @throws {AppwriteException}
|
|
150
186
|
* @returns {Promise<Models.App>}
|
|
151
187
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
152
188
|
*/
|
|
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>;
|
|
189
|
+
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>;
|
|
154
190
|
/**
|
|
155
191
|
* Delete an application by its unique ID.
|
|
156
192
|
*
|