@appwrite.io/console 2.3.0 → 3.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/CHANGELOG.md +14 -0
- package/README.md +2 -2
- package/dist/cjs/sdk.js +294 -28
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +294 -28
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +347 -61
- package/docs/examples/activities/get-event.md +15 -0
- package/docs/examples/activities/list-events.md +15 -0
- package/docs/examples/databases/create-longtext-attribute.md +2 -1
- package/docs/examples/databases/create-mediumtext-attribute.md +2 -1
- package/docs/examples/databases/create-text-attribute.md +2 -1
- package/docs/examples/databases/create-varchar-attribute.md +2 -1
- package/docs/examples/projects/create-schedule.md +20 -0
- package/docs/examples/projects/get-schedule.md +16 -0
- package/docs/examples/projects/list-schedules.md +17 -0
- package/docs/examples/tablesdb/create-longtext-column.md +2 -1
- package/docs/examples/tablesdb/create-mediumtext-column.md +2 -1
- package/docs/examples/tablesdb/create-text-column.md +2 -1
- package/docs/examples/tablesdb/create-varchar-column.md +2 -1
- package/package.json +2 -3
- package/src/channel.ts +4 -0
- package/src/client.ts +11 -3
- package/src/enums/build-runtime.ts +20 -3
- package/src/enums/email-template-type.ts +4 -4
- package/src/enums/o-auth-provider.ts +0 -2
- package/src/enums/resource-type.ts +6 -0
- package/src/enums/runtime.ts +20 -3
- package/src/enums/runtimes.ts +20 -3
- package/src/enums/scopes.ts +2 -0
- package/src/enums/sms-template-type.ts +1 -1
- package/src/index.ts +3 -0
- package/src/models.ts +250 -6
- package/src/services/account.ts +4 -4
- package/src/services/activities.ts +116 -0
- package/src/services/databases.ts +56 -28
- package/src/services/migrations.ts +2 -2
- package/src/services/projects.ts +223 -0
- package/src/services/tables-db.ts +56 -28
- package/types/channel.d.ts +1 -0
- package/types/enums/build-runtime.d.ts +20 -3
- package/types/enums/email-template-type.d.ts +4 -4
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/resource-type.d.ts +6 -0
- package/types/enums/runtime.d.ts +20 -3
- package/types/enums/runtimes.d.ts +20 -3
- package/types/enums/scopes.d.ts +2 -0
- package/types/enums/sms-template-type.d.ts +1 -1
- package/types/index.d.ts +3 -0
- package/types/models.d.ts +246 -6
- package/types/services/account.d.ts +4 -4
- package/types/services/activities.d.ts +46 -0
- package/types/services/databases.d.ts +16 -4
- package/types/services/migrations.d.ts +2 -2
- package/types/services/projects.d.ts +82 -0
- package/types/services/tables-db.d.ts +16 -4
package/types/models.d.ts
CHANGED
|
@@ -550,6 +550,19 @@ export declare namespace Models {
|
|
|
550
550
|
*/
|
|
551
551
|
rules: ProxyRule[];
|
|
552
552
|
};
|
|
553
|
+
/**
|
|
554
|
+
* Schedules List
|
|
555
|
+
*/
|
|
556
|
+
export type ScheduleList = {
|
|
557
|
+
/**
|
|
558
|
+
* Total number of schedules that matched your query.
|
|
559
|
+
*/
|
|
560
|
+
total: number;
|
|
561
|
+
/**
|
|
562
|
+
* List of schedules.
|
|
563
|
+
*/
|
|
564
|
+
schedules: Schedule[];
|
|
565
|
+
};
|
|
553
566
|
/**
|
|
554
567
|
* Locale codes list
|
|
555
568
|
*/
|
|
@@ -756,7 +769,7 @@ export declare namespace Models {
|
|
|
756
769
|
/**
|
|
757
770
|
* Collection attributes.
|
|
758
771
|
*/
|
|
759
|
-
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
|
|
772
|
+
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
|
|
760
773
|
/**
|
|
761
774
|
* Collection indexes.
|
|
762
775
|
*/
|
|
@@ -781,7 +794,7 @@ export declare namespace Models {
|
|
|
781
794
|
/**
|
|
782
795
|
* List of attributes.
|
|
783
796
|
*/
|
|
784
|
-
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
|
|
797
|
+
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeVarchar | Models.AttributeText | Models.AttributeMediumtext | Models.AttributeLongtext | Models.AttributeString)[];
|
|
785
798
|
};
|
|
786
799
|
/**
|
|
787
800
|
* AttributeString
|
|
@@ -1428,6 +1441,10 @@ export declare namespace Models {
|
|
|
1428
1441
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1429
1442
|
*/
|
|
1430
1443
|
default?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Defines whether this attribute is encrypted or not.
|
|
1446
|
+
*/
|
|
1447
|
+
encrypt?: boolean;
|
|
1431
1448
|
};
|
|
1432
1449
|
/**
|
|
1433
1450
|
* AttributeText
|
|
@@ -1469,6 +1486,10 @@ export declare namespace Models {
|
|
|
1469
1486
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1470
1487
|
*/
|
|
1471
1488
|
default?: string;
|
|
1489
|
+
/**
|
|
1490
|
+
* Defines whether this attribute is encrypted or not.
|
|
1491
|
+
*/
|
|
1492
|
+
encrypt?: boolean;
|
|
1472
1493
|
};
|
|
1473
1494
|
/**
|
|
1474
1495
|
* AttributeMediumtext
|
|
@@ -1510,6 +1531,10 @@ export declare namespace Models {
|
|
|
1510
1531
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1511
1532
|
*/
|
|
1512
1533
|
default?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* Defines whether this attribute is encrypted or not.
|
|
1536
|
+
*/
|
|
1537
|
+
encrypt?: boolean;
|
|
1513
1538
|
};
|
|
1514
1539
|
/**
|
|
1515
1540
|
* AttributeLongtext
|
|
@@ -1551,6 +1576,10 @@ export declare namespace Models {
|
|
|
1551
1576
|
* Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1552
1577
|
*/
|
|
1553
1578
|
default?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* Defines whether this attribute is encrypted or not.
|
|
1581
|
+
*/
|
|
1582
|
+
encrypt?: boolean;
|
|
1554
1583
|
};
|
|
1555
1584
|
/**
|
|
1556
1585
|
* Table
|
|
@@ -2263,6 +2292,10 @@ export declare namespace Models {
|
|
|
2263
2292
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2264
2293
|
*/
|
|
2265
2294
|
default?: string;
|
|
2295
|
+
/**
|
|
2296
|
+
* Defines whether this column is encrypted or not.
|
|
2297
|
+
*/
|
|
2298
|
+
encrypt?: boolean;
|
|
2266
2299
|
};
|
|
2267
2300
|
/**
|
|
2268
2301
|
* ColumnText
|
|
@@ -2304,6 +2337,10 @@ export declare namespace Models {
|
|
|
2304
2337
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2305
2338
|
*/
|
|
2306
2339
|
default?: string;
|
|
2340
|
+
/**
|
|
2341
|
+
* Defines whether this column is encrypted or not.
|
|
2342
|
+
*/
|
|
2343
|
+
encrypt?: boolean;
|
|
2307
2344
|
};
|
|
2308
2345
|
/**
|
|
2309
2346
|
* ColumnMediumtext
|
|
@@ -2345,6 +2382,10 @@ export declare namespace Models {
|
|
|
2345
2382
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2346
2383
|
*/
|
|
2347
2384
|
default?: string;
|
|
2385
|
+
/**
|
|
2386
|
+
* Defines whether this column is encrypted or not.
|
|
2387
|
+
*/
|
|
2388
|
+
encrypt?: boolean;
|
|
2348
2389
|
};
|
|
2349
2390
|
/**
|
|
2350
2391
|
* ColumnLongtext
|
|
@@ -2386,6 +2427,10 @@ export declare namespace Models {
|
|
|
2386
2427
|
* Default value for column when not provided. Cannot be set when column is required.
|
|
2387
2428
|
*/
|
|
2388
2429
|
default?: string;
|
|
2430
|
+
/**
|
|
2431
|
+
* Defines whether this column is encrypted or not.
|
|
2432
|
+
*/
|
|
2433
|
+
encrypt?: boolean;
|
|
2389
2434
|
};
|
|
2390
2435
|
/**
|
|
2391
2436
|
* Index
|
|
@@ -4468,6 +4513,10 @@ export declare namespace Models {
|
|
|
4468
4513
|
* Labels for the project.
|
|
4469
4514
|
*/
|
|
4470
4515
|
labels: string[];
|
|
4516
|
+
/**
|
|
4517
|
+
* Project status
|
|
4518
|
+
*/
|
|
4519
|
+
status: string;
|
|
4471
4520
|
/**
|
|
4472
4521
|
* Email/Password auth method status
|
|
4473
4522
|
*/
|
|
@@ -4552,10 +4601,6 @@ export declare namespace Models {
|
|
|
4552
4601
|
* Project region
|
|
4553
4602
|
*/
|
|
4554
4603
|
region: string;
|
|
4555
|
-
/**
|
|
4556
|
-
* Project status
|
|
4557
|
-
*/
|
|
4558
|
-
status: string;
|
|
4559
4604
|
/**
|
|
4560
4605
|
* Billing limits reached
|
|
4561
4606
|
*/
|
|
@@ -6011,6 +6056,55 @@ export declare namespace Models {
|
|
|
6011
6056
|
*/
|
|
6012
6057
|
renewAt: string;
|
|
6013
6058
|
};
|
|
6059
|
+
/**
|
|
6060
|
+
* Schedule
|
|
6061
|
+
*/
|
|
6062
|
+
export type Schedule = {
|
|
6063
|
+
/**
|
|
6064
|
+
* Schedule ID.
|
|
6065
|
+
*/
|
|
6066
|
+
$id: string;
|
|
6067
|
+
/**
|
|
6068
|
+
* Schedule creation date in ISO 8601 format.
|
|
6069
|
+
*/
|
|
6070
|
+
$createdAt: string;
|
|
6071
|
+
/**
|
|
6072
|
+
* Schedule update date in ISO 8601 format.
|
|
6073
|
+
*/
|
|
6074
|
+
$updatedAt: string;
|
|
6075
|
+
/**
|
|
6076
|
+
* The resource type associated with this schedule.
|
|
6077
|
+
*/
|
|
6078
|
+
resourceType: string;
|
|
6079
|
+
/**
|
|
6080
|
+
* The resource ID associated with this schedule.
|
|
6081
|
+
*/
|
|
6082
|
+
resourceId: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* Change-tracking timestamp used by the scheduler to detect resource changes in ISO 8601 format.
|
|
6085
|
+
*/
|
|
6086
|
+
resourceUpdatedAt: string;
|
|
6087
|
+
/**
|
|
6088
|
+
* The project ID associated with this schedule.
|
|
6089
|
+
*/
|
|
6090
|
+
projectId: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* The CRON schedule expression.
|
|
6093
|
+
*/
|
|
6094
|
+
schedule: string;
|
|
6095
|
+
/**
|
|
6096
|
+
* Schedule data used to store resource-specific context needed for execution.
|
|
6097
|
+
*/
|
|
6098
|
+
data: object;
|
|
6099
|
+
/**
|
|
6100
|
+
* Whether the schedule is active.
|
|
6101
|
+
*/
|
|
6102
|
+
active: boolean;
|
|
6103
|
+
/**
|
|
6104
|
+
* The region where the schedule is deployed.
|
|
6105
|
+
*/
|
|
6106
|
+
region: string;
|
|
6107
|
+
};
|
|
6014
6108
|
/**
|
|
6015
6109
|
* SmsTemplate
|
|
6016
6110
|
*/
|
|
@@ -6534,6 +6628,139 @@ export declare namespace Models {
|
|
|
6534
6628
|
*/
|
|
6535
6629
|
version: string;
|
|
6536
6630
|
};
|
|
6631
|
+
/**
|
|
6632
|
+
* ActivityEvent
|
|
6633
|
+
*/
|
|
6634
|
+
export type ActivityEvent = {
|
|
6635
|
+
/**
|
|
6636
|
+
* Event ID.
|
|
6637
|
+
*/
|
|
6638
|
+
$id: string;
|
|
6639
|
+
/**
|
|
6640
|
+
* User type.
|
|
6641
|
+
*/
|
|
6642
|
+
userType: string;
|
|
6643
|
+
/**
|
|
6644
|
+
* User ID.
|
|
6645
|
+
*/
|
|
6646
|
+
userId: string;
|
|
6647
|
+
/**
|
|
6648
|
+
* User Email.
|
|
6649
|
+
*/
|
|
6650
|
+
userEmail: string;
|
|
6651
|
+
/**
|
|
6652
|
+
* User Name.
|
|
6653
|
+
*/
|
|
6654
|
+
userName: string;
|
|
6655
|
+
/**
|
|
6656
|
+
* Resource parent.
|
|
6657
|
+
*/
|
|
6658
|
+
resourceParent: string;
|
|
6659
|
+
/**
|
|
6660
|
+
* Resource type.
|
|
6661
|
+
*/
|
|
6662
|
+
resourceType: string;
|
|
6663
|
+
/**
|
|
6664
|
+
* Resource ID.
|
|
6665
|
+
*/
|
|
6666
|
+
resourceId: string;
|
|
6667
|
+
/**
|
|
6668
|
+
* Resource.
|
|
6669
|
+
*/
|
|
6670
|
+
resource: string;
|
|
6671
|
+
/**
|
|
6672
|
+
* Event name.
|
|
6673
|
+
*/
|
|
6674
|
+
event: string;
|
|
6675
|
+
/**
|
|
6676
|
+
* User agent.
|
|
6677
|
+
*/
|
|
6678
|
+
userAgent: string;
|
|
6679
|
+
/**
|
|
6680
|
+
* IP address.
|
|
6681
|
+
*/
|
|
6682
|
+
ip: string;
|
|
6683
|
+
/**
|
|
6684
|
+
* API mode when event triggered.
|
|
6685
|
+
*/
|
|
6686
|
+
mode: string;
|
|
6687
|
+
/**
|
|
6688
|
+
* Location.
|
|
6689
|
+
*/
|
|
6690
|
+
country: string;
|
|
6691
|
+
/**
|
|
6692
|
+
* Log creation date in ISO 8601 format.
|
|
6693
|
+
*/
|
|
6694
|
+
time: string;
|
|
6695
|
+
/**
|
|
6696
|
+
* Project ID.
|
|
6697
|
+
*/
|
|
6698
|
+
projectId: string;
|
|
6699
|
+
/**
|
|
6700
|
+
* Team ID.
|
|
6701
|
+
*/
|
|
6702
|
+
teamId: string;
|
|
6703
|
+
/**
|
|
6704
|
+
* Hostname.
|
|
6705
|
+
*/
|
|
6706
|
+
hostname: string;
|
|
6707
|
+
/**
|
|
6708
|
+
* Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json).
|
|
6709
|
+
*/
|
|
6710
|
+
osCode: string;
|
|
6711
|
+
/**
|
|
6712
|
+
* Operating system name.
|
|
6713
|
+
*/
|
|
6714
|
+
osName: string;
|
|
6715
|
+
/**
|
|
6716
|
+
* Operating system version.
|
|
6717
|
+
*/
|
|
6718
|
+
osVersion: string;
|
|
6719
|
+
/**
|
|
6720
|
+
* Client type.
|
|
6721
|
+
*/
|
|
6722
|
+
clientType: string;
|
|
6723
|
+
/**
|
|
6724
|
+
* Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json).
|
|
6725
|
+
*/
|
|
6726
|
+
clientCode: string;
|
|
6727
|
+
/**
|
|
6728
|
+
* Client name.
|
|
6729
|
+
*/
|
|
6730
|
+
clientName: string;
|
|
6731
|
+
/**
|
|
6732
|
+
* Client version.
|
|
6733
|
+
*/
|
|
6734
|
+
clientVersion: string;
|
|
6735
|
+
/**
|
|
6736
|
+
* Client engine name.
|
|
6737
|
+
*/
|
|
6738
|
+
clientEngine: string;
|
|
6739
|
+
/**
|
|
6740
|
+
* Client engine name.
|
|
6741
|
+
*/
|
|
6742
|
+
clientEngineVersion: string;
|
|
6743
|
+
/**
|
|
6744
|
+
* Device name.
|
|
6745
|
+
*/
|
|
6746
|
+
deviceName: string;
|
|
6747
|
+
/**
|
|
6748
|
+
* Device brand name.
|
|
6749
|
+
*/
|
|
6750
|
+
deviceBrand: string;
|
|
6751
|
+
/**
|
|
6752
|
+
* Device model name.
|
|
6753
|
+
*/
|
|
6754
|
+
deviceModel: string;
|
|
6755
|
+
/**
|
|
6756
|
+
* Country two-character ISO 3166-1 alpha code.
|
|
6757
|
+
*/
|
|
6758
|
+
countryCode: string;
|
|
6759
|
+
/**
|
|
6760
|
+
* Country name.
|
|
6761
|
+
*/
|
|
6762
|
+
countryName: string;
|
|
6763
|
+
};
|
|
6537
6764
|
/**
|
|
6538
6765
|
* AdditionalResource
|
|
6539
6766
|
*/
|
|
@@ -8413,6 +8640,19 @@ export declare namespace Models {
|
|
|
8413
8640
|
*/
|
|
8414
8641
|
available: boolean;
|
|
8415
8642
|
};
|
|
8643
|
+
/**
|
|
8644
|
+
* Activity event list
|
|
8645
|
+
*/
|
|
8646
|
+
export type ActivityEventList = {
|
|
8647
|
+
/**
|
|
8648
|
+
* Total number of events that matched your query.
|
|
8649
|
+
*/
|
|
8650
|
+
total: number;
|
|
8651
|
+
/**
|
|
8652
|
+
* List of events.
|
|
8653
|
+
*/
|
|
8654
|
+
events: ActivityEvent[];
|
|
8655
|
+
};
|
|
8416
8656
|
/**
|
|
8417
8657
|
* Aggregation team list
|
|
8418
8658
|
*/
|
|
@@ -1076,7 +1076,7 @@ export declare class Account {
|
|
|
1076
1076
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1077
1077
|
*
|
|
1078
1078
|
*
|
|
1079
|
-
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom
|
|
1079
|
+
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1080
1080
|
* @param {string} params.success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1081
1081
|
* @param {string} params.failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1082
1082
|
* @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1097,7 +1097,7 @@ export declare class Account {
|
|
|
1097
1097
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1098
1098
|
*
|
|
1099
1099
|
*
|
|
1100
|
-
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom
|
|
1100
|
+
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1101
1101
|
* @param {string} success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1102
1102
|
* @param {string} failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1103
1103
|
* @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1353,7 +1353,7 @@ export declare class Account {
|
|
|
1353
1353
|
*
|
|
1354
1354
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1355
1355
|
*
|
|
1356
|
-
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom
|
|
1356
|
+
* @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1357
1357
|
* @param {string} params.success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1358
1358
|
* @param {string} params.failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1359
1359
|
* @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -1373,7 +1373,7 @@ export declare class Account {
|
|
|
1373
1373
|
*
|
|
1374
1374
|
* A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
|
|
1375
1375
|
*
|
|
1376
|
-
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom
|
|
1376
|
+
* @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
|
|
1377
1377
|
* @param {string} success - URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1378
1378
|
* @param {string} failure - URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
|
|
1379
1379
|
* @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Activities {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* List all events for selected filters.
|
|
8
|
+
*
|
|
9
|
+
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
|
|
10
|
+
* @throws {AppwriteException}
|
|
11
|
+
* @returns {Promise<Models.ActivityEventList>}
|
|
12
|
+
*/
|
|
13
|
+
listEvents(params?: {
|
|
14
|
+
queries?: string;
|
|
15
|
+
}): Promise<Models.ActivityEventList>;
|
|
16
|
+
/**
|
|
17
|
+
* List all events for selected filters.
|
|
18
|
+
*
|
|
19
|
+
* @param {string} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as userId, teamId, etc.
|
|
20
|
+
* @throws {AppwriteException}
|
|
21
|
+
* @returns {Promise<Models.ActivityEventList>}
|
|
22
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
23
|
+
*/
|
|
24
|
+
listEvents(queries?: string): Promise<Models.ActivityEventList>;
|
|
25
|
+
/**
|
|
26
|
+
* Get event by ID.
|
|
27
|
+
*
|
|
28
|
+
*
|
|
29
|
+
* @param {string} params.eventId - Event ID.
|
|
30
|
+
* @throws {AppwriteException}
|
|
31
|
+
* @returns {Promise<Models.ActivityEvent>}
|
|
32
|
+
*/
|
|
33
|
+
getEvent(params: {
|
|
34
|
+
eventId: string;
|
|
35
|
+
}): Promise<Models.ActivityEvent>;
|
|
36
|
+
/**
|
|
37
|
+
* Get event by ID.
|
|
38
|
+
*
|
|
39
|
+
*
|
|
40
|
+
* @param {string} eventId - Event ID.
|
|
41
|
+
* @throws {AppwriteException}
|
|
42
|
+
* @returns {Promise<Models.ActivityEvent>}
|
|
43
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
44
|
+
*/
|
|
45
|
+
getEvent(eventId: string): Promise<Models.ActivityEvent>;
|
|
46
|
+
}
|
|
@@ -1070,6 +1070,7 @@ export declare class Databases {
|
|
|
1070
1070
|
* @param {boolean} params.required - Is attribute required?
|
|
1071
1071
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1072
1072
|
* @param {boolean} params.array - Is attribute an array?
|
|
1073
|
+
* @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.
|
|
1073
1074
|
* @throws {AppwriteException}
|
|
1074
1075
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1075
1076
|
*/
|
|
@@ -1080,6 +1081,7 @@ export declare class Databases {
|
|
|
1080
1081
|
required: boolean;
|
|
1081
1082
|
xdefault?: string;
|
|
1082
1083
|
array?: boolean;
|
|
1084
|
+
encrypt?: boolean;
|
|
1083
1085
|
}): Promise<Models.AttributeLongtext>;
|
|
1084
1086
|
/**
|
|
1085
1087
|
* Create a longtext attribute.
|
|
@@ -1091,11 +1093,12 @@ export declare class Databases {
|
|
|
1091
1093
|
* @param {boolean} required - Is attribute required?
|
|
1092
1094
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1093
1095
|
* @param {boolean} array - Is attribute an array?
|
|
1096
|
+
* @param {boolean} 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.
|
|
1094
1097
|
* @throws {AppwriteException}
|
|
1095
1098
|
* @returns {Promise<Models.AttributeLongtext>}
|
|
1096
1099
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1097
1100
|
*/
|
|
1098
|
-
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeLongtext>;
|
|
1101
|
+
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeLongtext>;
|
|
1099
1102
|
/**
|
|
1100
1103
|
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1101
1104
|
*
|
|
@@ -1142,6 +1145,7 @@ export declare class Databases {
|
|
|
1142
1145
|
* @param {boolean} params.required - Is attribute required?
|
|
1143
1146
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1144
1147
|
* @param {boolean} params.array - Is attribute an array?
|
|
1148
|
+
* @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.
|
|
1145
1149
|
* @throws {AppwriteException}
|
|
1146
1150
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1147
1151
|
*/
|
|
@@ -1152,6 +1156,7 @@ export declare class Databases {
|
|
|
1152
1156
|
required: boolean;
|
|
1153
1157
|
xdefault?: string;
|
|
1154
1158
|
array?: boolean;
|
|
1159
|
+
encrypt?: boolean;
|
|
1155
1160
|
}): Promise<Models.AttributeMediumtext>;
|
|
1156
1161
|
/**
|
|
1157
1162
|
* Create a mediumtext attribute.
|
|
@@ -1163,11 +1168,12 @@ export declare class Databases {
|
|
|
1163
1168
|
* @param {boolean} required - Is attribute required?
|
|
1164
1169
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1165
1170
|
* @param {boolean} array - Is attribute an array?
|
|
1171
|
+
* @param {boolean} 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.
|
|
1166
1172
|
* @throws {AppwriteException}
|
|
1167
1173
|
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1168
1174
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1169
1175
|
*/
|
|
1170
|
-
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1176
|
+
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1171
1177
|
/**
|
|
1172
1178
|
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1173
1179
|
*
|
|
@@ -1474,6 +1480,7 @@ export declare class Databases {
|
|
|
1474
1480
|
* @param {boolean} params.required - Is attribute required?
|
|
1475
1481
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1476
1482
|
* @param {boolean} params.array - Is attribute an array?
|
|
1483
|
+
* @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.
|
|
1477
1484
|
* @throws {AppwriteException}
|
|
1478
1485
|
* @returns {Promise<Models.AttributeText>}
|
|
1479
1486
|
*/
|
|
@@ -1484,6 +1491,7 @@ export declare class Databases {
|
|
|
1484
1491
|
required: boolean;
|
|
1485
1492
|
xdefault?: string;
|
|
1486
1493
|
array?: boolean;
|
|
1494
|
+
encrypt?: boolean;
|
|
1487
1495
|
}): Promise<Models.AttributeText>;
|
|
1488
1496
|
/**
|
|
1489
1497
|
* Create a text attribute.
|
|
@@ -1495,11 +1503,12 @@ export declare class Databases {
|
|
|
1495
1503
|
* @param {boolean} required - Is attribute required?
|
|
1496
1504
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1497
1505
|
* @param {boolean} array - Is attribute an array?
|
|
1506
|
+
* @param {boolean} 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.
|
|
1498
1507
|
* @throws {AppwriteException}
|
|
1499
1508
|
* @returns {Promise<Models.AttributeText>}
|
|
1500
1509
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1501
1510
|
*/
|
|
1502
|
-
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeText>;
|
|
1511
|
+
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeText>;
|
|
1503
1512
|
/**
|
|
1504
1513
|
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1505
1514
|
*
|
|
@@ -1621,6 +1630,7 @@ export declare class Databases {
|
|
|
1621
1630
|
* @param {boolean} params.required - Is attribute required?
|
|
1622
1631
|
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1623
1632
|
* @param {boolean} params.array - Is attribute an array?
|
|
1633
|
+
* @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.
|
|
1624
1634
|
* @throws {AppwriteException}
|
|
1625
1635
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1626
1636
|
*/
|
|
@@ -1632,6 +1642,7 @@ export declare class Databases {
|
|
|
1632
1642
|
required: boolean;
|
|
1633
1643
|
xdefault?: string;
|
|
1634
1644
|
array?: boolean;
|
|
1645
|
+
encrypt?: boolean;
|
|
1635
1646
|
}): Promise<Models.AttributeVarchar>;
|
|
1636
1647
|
/**
|
|
1637
1648
|
* Create a varchar attribute.
|
|
@@ -1644,11 +1655,12 @@ export declare class Databases {
|
|
|
1644
1655
|
* @param {boolean} required - Is attribute required?
|
|
1645
1656
|
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1646
1657
|
* @param {boolean} array - Is attribute an array?
|
|
1658
|
+
* @param {boolean} 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.
|
|
1647
1659
|
* @throws {AppwriteException}
|
|
1648
1660
|
* @returns {Promise<Models.AttributeVarchar>}
|
|
1649
1661
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1650
1662
|
*/
|
|
1651
|
-
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.AttributeVarchar>;
|
|
1663
|
+
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeVarchar>;
|
|
1652
1664
|
/**
|
|
1653
1665
|
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1654
1666
|
*
|
|
@@ -7,7 +7,7 @@ export declare class Migrations {
|
|
|
7
7
|
/**
|
|
8
8
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
9
9
|
*
|
|
10
|
-
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
10
|
+
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
11
11
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
12
12
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
13
13
|
* @throws {AppwriteException}
|
|
@@ -21,7 +21,7 @@ export declare class Migrations {
|
|
|
21
21
|
/**
|
|
22
22
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
23
23
|
*
|
|
24
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
|
|
24
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
25
25
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
26
26
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
27
27
|
* @throws {AppwriteException}
|