@appwrite.io/console 3.0.0 → 4.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 +5 -0
- package/README.md +1 -1
- package/dist/cjs/sdk.js +470 -83
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +471 -84
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +470 -83
- package/docs/examples/databases/list-documents.md +2 -1
- package/docs/examples/domains/create-purchase.md +25 -0
- package/docs/examples/domains/create-transfer-in.md +18 -0
- package/docs/examples/domains/create-transfer-out.md +16 -0
- package/docs/examples/domains/get-transfer-status.md +15 -0
- package/docs/examples/health/get-console-pausing.md +16 -0
- package/docs/examples/migrations/create-appwrite-migration.md +2 -2
- package/docs/examples/migrations/create-firebase-migration.md +2 -2
- package/docs/examples/migrations/create-n-host-migration.md +2 -2
- package/docs/examples/migrations/create-supabase-migration.md +2 -2
- package/docs/examples/migrations/get-appwrite-report.md +2 -2
- package/docs/examples/migrations/get-firebase-report.md +2 -2
- package/docs/examples/migrations/get-n-host-report.md +2 -2
- package/docs/examples/migrations/get-supabase-report.md +2 -2
- package/docs/examples/organizations/get-scopes.md +2 -1
- package/docs/examples/projects/update-console-access.md +15 -0
- package/docs/examples/projects/update-status.md +16 -0
- package/docs/examples/sites/create-deployment.md +2 -2
- package/docs/examples/tablesdb/list-rows.md +2 -1
- package/package.json +1 -1
- package/src/channel.ts +19 -15
- package/src/client.ts +7 -2
- package/src/enums/appwrite-migration-resource.ts +21 -0
- package/src/enums/domain-transfer-status-status.ts +10 -0
- package/src/enums/firebase-migration-resource.ts +12 -0
- package/src/enums/{resources.ts → n-host-migration-resource.ts} +1 -1
- package/src/enums/status.ts +3 -0
- package/src/enums/supabase-migration-resource.ts +13 -0
- package/src/index.ts +6 -1
- package/src/models.ts +124 -3
- package/src/query.ts +26 -0
- package/src/services/account.ts +2 -2
- package/src/services/databases.ts +100 -93
- package/src/services/domains.ts +350 -0
- package/src/services/health.ts +61 -0
- package/src/services/messaging.ts +2 -2
- package/src/services/migrations.ts +68 -65
- package/src/services/organizations.ts +14 -6
- package/src/services/projects.ts +120 -0
- package/src/services/sites.ts +13 -16
- package/src/services/tables-db.ts +14 -7
- package/src/services/teams.ts +4 -4
- package/types/channel.d.ts +9 -9
- package/types/enums/appwrite-migration-resource.d.ts +21 -0
- package/types/enums/domain-transfer-status-status.d.ts +10 -0
- package/types/enums/firebase-migration-resource.d.ts +12 -0
- package/types/enums/{resources.d.ts → n-host-migration-resource.d.ts} +1 -1
- package/types/enums/status.d.ts +3 -0
- package/types/enums/supabase-migration-resource.d.ts +13 -0
- package/types/index.d.ts +6 -1
- package/types/models.d.ts +122 -3
- package/types/query.d.ts +22 -0
- package/types/services/databases.d.ts +40 -37
- package/types/services/domains.d.ts +118 -0
- package/types/services/health.d.ts +24 -0
- package/types/services/messaging.d.ts +2 -2
- package/types/services/migrations.d.ts +36 -33
- package/types/services/organizations.d.ts +4 -1
- package/types/services/projects.d.ts +46 -0
- package/types/services/sites.d.ts +4 -4
- package/types/services/tables-db.d.ts +4 -1
- package/types/services/teams.d.ts +4 -4
package/src/services/sites.ts
CHANGED
|
@@ -912,56 +912,56 @@ export class Sites {
|
|
|
912
912
|
*
|
|
913
913
|
* @param {string} params.siteId - Site ID.
|
|
914
914
|
* @param {File} params.code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
|
|
915
|
-
* @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
|
|
916
915
|
* @param {string} params.installCommand - Install Commands.
|
|
917
916
|
* @param {string} params.buildCommand - Build Commands.
|
|
918
917
|
* @param {string} params.outputDirectory - Output Directory.
|
|
918
|
+
* @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
|
|
919
919
|
* @throws {AppwriteException}
|
|
920
920
|
* @returns {Promise<Models.Deployment>}
|
|
921
921
|
*/
|
|
922
|
-
createDeployment(params: { siteId: string, code: File,
|
|
922
|
+
createDeployment(params: { siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean, onProgress?: (progress: UploadProgress) => void }): Promise<Models.Deployment>;
|
|
923
923
|
/**
|
|
924
924
|
* Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.
|
|
925
925
|
*
|
|
926
926
|
* @param {string} siteId - Site ID.
|
|
927
927
|
* @param {File} code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
|
|
928
|
-
* @param {boolean} activate - Automatically activate the deployment when it is finished building.
|
|
929
928
|
* @param {string} installCommand - Install Commands.
|
|
930
929
|
* @param {string} buildCommand - Build Commands.
|
|
931
930
|
* @param {string} outputDirectory - Output Directory.
|
|
931
|
+
* @param {boolean} activate - Automatically activate the deployment when it is finished building.
|
|
932
932
|
* @throws {AppwriteException}
|
|
933
933
|
* @returns {Promise<Models.Deployment>}
|
|
934
934
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
935
935
|
*/
|
|
936
|
-
createDeployment(siteId: string, code: File,
|
|
936
|
+
createDeployment(siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
|
|
937
937
|
createDeployment(
|
|
938
|
-
paramsOrFirst: { siteId: string, code: File,
|
|
939
|
-
...rest: [(File)?, (
|
|
938
|
+
paramsOrFirst: { siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean, onProgress?: (progress: UploadProgress) => void } | string,
|
|
939
|
+
...rest: [(File)?, (string)?, (string)?, (string)?, (boolean)?,((progress: UploadProgress) => void)?]
|
|
940
940
|
): Promise<Models.Deployment> {
|
|
941
|
-
let params: { siteId: string, code: File,
|
|
941
|
+
let params: { siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean };
|
|
942
942
|
let onProgress: ((progress: UploadProgress) => void);
|
|
943
943
|
|
|
944
944
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
945
|
-
params = (paramsOrFirst || {}) as { siteId: string, code: File,
|
|
945
|
+
params = (paramsOrFirst || {}) as { siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean };
|
|
946
946
|
onProgress = paramsOrFirst?.onProgress as ((progress: UploadProgress) => void);
|
|
947
947
|
} else {
|
|
948
948
|
params = {
|
|
949
949
|
siteId: paramsOrFirst as string,
|
|
950
950
|
code: rest[0] as File,
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
951
|
+
installCommand: rest[1] as string,
|
|
952
|
+
buildCommand: rest[2] as string,
|
|
953
|
+
outputDirectory: rest[3] as string,
|
|
954
|
+
activate: rest[4] as boolean
|
|
955
955
|
};
|
|
956
956
|
onProgress = rest[5] as ((progress: UploadProgress) => void);
|
|
957
957
|
}
|
|
958
958
|
|
|
959
959
|
const siteId = params.siteId;
|
|
960
960
|
const code = params.code;
|
|
961
|
-
const activate = params.activate;
|
|
962
961
|
const installCommand = params.installCommand;
|
|
963
962
|
const buildCommand = params.buildCommand;
|
|
964
963
|
const outputDirectory = params.outputDirectory;
|
|
964
|
+
const activate = params.activate;
|
|
965
965
|
|
|
966
966
|
if (typeof siteId === 'undefined') {
|
|
967
967
|
throw new AppwriteException('Missing required parameter: "siteId"');
|
|
@@ -969,9 +969,6 @@ export class Sites {
|
|
|
969
969
|
if (typeof code === 'undefined') {
|
|
970
970
|
throw new AppwriteException('Missing required parameter: "code"');
|
|
971
971
|
}
|
|
972
|
-
if (typeof activate === 'undefined') {
|
|
973
|
-
throw new AppwriteException('Missing required parameter: "activate"');
|
|
974
|
-
}
|
|
975
972
|
|
|
976
973
|
const apiPath = '/sites/{siteId}/deployments'.replace('{siteId}', siteId);
|
|
977
974
|
const payload: Payload = {};
|
|
@@ -5052,10 +5052,11 @@ export class TablesDB {
|
|
|
5052
5052
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
5053
5053
|
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
5054
5054
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
5055
|
+
* @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
5055
5056
|
* @throws {AppwriteException}
|
|
5056
5057
|
* @returns {Promise<Models.RowList<Row>>}
|
|
5057
5058
|
*/
|
|
5058
|
-
listRows<Row extends Models.Row = Models.DefaultRow>(params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean }): Promise<Models.RowList<Row>>;
|
|
5059
|
+
listRows<Row extends Models.Row = Models.DefaultRow>(params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number }): Promise<Models.RowList<Row>>;
|
|
5059
5060
|
/**
|
|
5060
5061
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
5061
5062
|
*
|
|
@@ -5064,26 +5065,28 @@ export class TablesDB {
|
|
|
5064
5065
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
5065
5066
|
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
5066
5067
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
5068
|
+
* @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
5067
5069
|
* @throws {AppwriteException}
|
|
5068
5070
|
* @returns {Promise<Models.RowList<Row>>}
|
|
5069
5071
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
5070
5072
|
*/
|
|
5071
|
-
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
|
|
5073
|
+
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
|
|
5072
5074
|
listRows<Row extends Models.Row = Models.DefaultRow>(
|
|
5073
|
-
paramsOrFirst: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean } | string,
|
|
5074
|
-
...rest: [(string)?, (string[])?, (string)?, (boolean)?]
|
|
5075
|
+
paramsOrFirst: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number } | string,
|
|
5076
|
+
...rest: [(string)?, (string[])?, (string)?, (boolean)?, (number)?]
|
|
5075
5077
|
): Promise<Models.RowList<Row>> {
|
|
5076
|
-
let params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean };
|
|
5078
|
+
let params: { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
|
|
5077
5079
|
|
|
5078
5080
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
5079
|
-
params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean };
|
|
5081
|
+
params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
|
|
5080
5082
|
} else {
|
|
5081
5083
|
params = {
|
|
5082
5084
|
databaseId: paramsOrFirst as string,
|
|
5083
5085
|
tableId: rest[0] as string,
|
|
5084
5086
|
queries: rest[1] as string[],
|
|
5085
5087
|
transactionId: rest[2] as string,
|
|
5086
|
-
total: rest[3] as boolean
|
|
5088
|
+
total: rest[3] as boolean,
|
|
5089
|
+
ttl: rest[4] as number
|
|
5087
5090
|
};
|
|
5088
5091
|
}
|
|
5089
5092
|
|
|
@@ -5092,6 +5095,7 @@ export class TablesDB {
|
|
|
5092
5095
|
const queries = params.queries;
|
|
5093
5096
|
const transactionId = params.transactionId;
|
|
5094
5097
|
const total = params.total;
|
|
5098
|
+
const ttl = params.ttl;
|
|
5095
5099
|
|
|
5096
5100
|
if (typeof databaseId === 'undefined') {
|
|
5097
5101
|
throw new AppwriteException('Missing required parameter: "databaseId"');
|
|
@@ -5111,6 +5115,9 @@ export class TablesDB {
|
|
|
5111
5115
|
if (typeof total !== 'undefined') {
|
|
5112
5116
|
payload['total'] = total;
|
|
5113
5117
|
}
|
|
5118
|
+
if (typeof ttl !== 'undefined') {
|
|
5119
|
+
payload['ttl'] = ttl;
|
|
5120
|
+
}
|
|
5114
5121
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
5115
5122
|
|
|
5116
5123
|
const apiHeaders: { [header: string]: string } = {
|
package/src/services/teams.ts
CHANGED
|
@@ -465,7 +465,7 @@ export class Teams {
|
|
|
465
465
|
*
|
|
466
466
|
*
|
|
467
467
|
* @param {string} params.teamId - Team ID.
|
|
468
|
-
* @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each
|
|
468
|
+
* @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
|
|
469
469
|
* @param {string} params.email - Email of the new team member.
|
|
470
470
|
* @param {string} params.userId - ID of the user to be added to a team.
|
|
471
471
|
* @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
@@ -486,7 +486,7 @@ export class Teams {
|
|
|
486
486
|
*
|
|
487
487
|
*
|
|
488
488
|
* @param {string} teamId - Team ID.
|
|
489
|
-
* @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each
|
|
489
|
+
* @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
|
|
490
490
|
* @param {string} email - Email of the new team member.
|
|
491
491
|
* @param {string} userId - ID of the user to be added to a team.
|
|
492
492
|
* @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
|
|
@@ -631,7 +631,7 @@ export class Teams {
|
|
|
631
631
|
*
|
|
632
632
|
* @param {string} params.teamId - Team ID.
|
|
633
633
|
* @param {string} params.membershipId - Membership ID.
|
|
634
|
-
* @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each
|
|
634
|
+
* @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
|
|
635
635
|
* @throws {AppwriteException}
|
|
636
636
|
* @returns {Promise<Models.Membership>}
|
|
637
637
|
*/
|
|
@@ -642,7 +642,7 @@ export class Teams {
|
|
|
642
642
|
*
|
|
643
643
|
* @param {string} teamId - Team ID.
|
|
644
644
|
* @param {string} membershipId - Membership ID.
|
|
645
|
-
* @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each
|
|
645
|
+
* @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
|
|
646
646
|
* @throws {AppwriteException}
|
|
647
647
|
* @returns {Promise<Models.Membership>}
|
|
648
648
|
* @deprecated Use the object parameter style method for a better developer experience.
|
package/types/channel.d.ts
CHANGED
|
@@ -45,22 +45,22 @@ export declare class Channel<T> {
|
|
|
45
45
|
private next;
|
|
46
46
|
private resolve;
|
|
47
47
|
toString(): string;
|
|
48
|
-
collection(this: Channel<Database>, id
|
|
48
|
+
collection(this: Channel<Database>, id: string): Channel<Collection>;
|
|
49
49
|
document(this: Channel<Collection>, id?: string): Channel<Document>;
|
|
50
|
-
table(this: Channel<TablesDB>, id
|
|
50
|
+
table(this: Channel<TablesDB>, id: string): Channel<Table>;
|
|
51
51
|
row(this: Channel<Table>, id?: string): Channel<Row>;
|
|
52
52
|
file(this: Channel<Bucket>, id?: string): Channel<File>;
|
|
53
53
|
create(this: Channel<Actionable>): Channel<Resolved>;
|
|
54
54
|
upsert(this: Channel<Document | Row>): Channel<Resolved>;
|
|
55
55
|
update(this: Channel<Actionable>): Channel<Resolved>;
|
|
56
56
|
delete(this: Channel<Actionable>): Channel<Resolved>;
|
|
57
|
-
static database(id
|
|
58
|
-
static execution(id
|
|
59
|
-
static tablesdb(id
|
|
60
|
-
static bucket(id
|
|
61
|
-
static function(id
|
|
62
|
-
static team(id
|
|
63
|
-
static membership(id
|
|
57
|
+
static database(id: string): Channel<Database>;
|
|
58
|
+
static execution(id: string): Channel<Execution>;
|
|
59
|
+
static tablesdb(id: string): Channel<TablesDB>;
|
|
60
|
+
static bucket(id: string): Channel<Bucket>;
|
|
61
|
+
static function(id: string): Channel<Func>;
|
|
62
|
+
static team(id: string): Channel<Team>;
|
|
63
|
+
static membership(id: string): Channel<Membership>;
|
|
64
64
|
static account(): string;
|
|
65
65
|
static documents(): string;
|
|
66
66
|
static rows(): string;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
export declare enum AppwriteMigrationResource {
|
|
2
|
+
User = "user",
|
|
3
|
+
Team = "team",
|
|
4
|
+
Membership = "membership",
|
|
5
|
+
Database = "database",
|
|
6
|
+
Table = "table",
|
|
7
|
+
Column = "column",
|
|
8
|
+
Index = "index",
|
|
9
|
+
Row = "row",
|
|
10
|
+
Document = "document",
|
|
11
|
+
Attribute = "attribute",
|
|
12
|
+
Collection = "collection",
|
|
13
|
+
Bucket = "bucket",
|
|
14
|
+
File = "file",
|
|
15
|
+
Function = "function",
|
|
16
|
+
Deployment = "deployment",
|
|
17
|
+
Environmentvariable = "environment-variable",
|
|
18
|
+
Site = "site",
|
|
19
|
+
Sitedeployment = "site-deployment",
|
|
20
|
+
Sitevariable = "site-variable"
|
|
21
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare enum DomainTransferStatusStatus {
|
|
2
|
+
Transferrable = "transferrable",
|
|
3
|
+
NotTransferrable = "not_transferrable",
|
|
4
|
+
PendingOwner = "pending_owner",
|
|
5
|
+
PendingAdmin = "pending_admin",
|
|
6
|
+
PendingRegistry = "pending_registry",
|
|
7
|
+
Completed = "completed",
|
|
8
|
+
Cancelled = "cancelled",
|
|
9
|
+
ServiceUnavailable = "service_unavailable"
|
|
10
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export declare enum FirebaseMigrationResource {
|
|
2
|
+
User = "user",
|
|
3
|
+
Database = "database",
|
|
4
|
+
Table = "table",
|
|
5
|
+
Column = "column",
|
|
6
|
+
Row = "row",
|
|
7
|
+
Document = "document",
|
|
8
|
+
Attribute = "attribute",
|
|
9
|
+
Collection = "collection",
|
|
10
|
+
Bucket = "bucket",
|
|
11
|
+
File = "file"
|
|
12
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare enum SupabaseMigrationResource {
|
|
2
|
+
User = "user",
|
|
3
|
+
Database = "database",
|
|
4
|
+
Table = "table",
|
|
5
|
+
Column = "column",
|
|
6
|
+
Index = "index",
|
|
7
|
+
Row = "row",
|
|
8
|
+
Document = "document",
|
|
9
|
+
Attribute = "attribute",
|
|
10
|
+
Collection = "collection",
|
|
11
|
+
Bucket = "bucket",
|
|
12
|
+
File = "file"
|
|
13
|
+
}
|
package/types/index.d.ts
CHANGED
|
@@ -71,7 +71,10 @@ export { ExecutionMethod } from './enums/execution-method';
|
|
|
71
71
|
export { Name } from './enums/name';
|
|
72
72
|
export { MessagePriority } from './enums/message-priority';
|
|
73
73
|
export { SmtpEncryption } from './enums/smtp-encryption';
|
|
74
|
-
export {
|
|
74
|
+
export { AppwriteMigrationResource } from './enums/appwrite-migration-resource';
|
|
75
|
+
export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
|
|
76
|
+
export { NHostMigrationResource } from './enums/n-host-migration-resource';
|
|
77
|
+
export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
|
|
75
78
|
export { ProjectUsageRange } from './enums/project-usage-range';
|
|
76
79
|
export { Region } from './enums/region';
|
|
77
80
|
export { Api } from './enums/api';
|
|
@@ -80,6 +83,7 @@ export { PlatformType } from './enums/platform-type';
|
|
|
80
83
|
export { ResourceType } from './enums/resource-type';
|
|
81
84
|
export { ApiService } from './enums/api-service';
|
|
82
85
|
export { SMTPSecure } from './enums/smtp-secure';
|
|
86
|
+
export { Status } from './enums/status';
|
|
83
87
|
export { EmailTemplateType } from './enums/email-template-type';
|
|
84
88
|
export { EmailTemplateLocale } from './enums/email-template-locale';
|
|
85
89
|
export { SmsTemplateType } from './enums/sms-template-type';
|
|
@@ -108,3 +112,4 @@ export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-r
|
|
|
108
112
|
export { ProxyRuleStatus } from './enums/proxy-rule-status';
|
|
109
113
|
export { MessageStatus } from './enums/message-status';
|
|
110
114
|
export { BillingPlanGroup } from './enums/billing-plan-group';
|
|
115
|
+
export { DomainTransferStatusStatus } from './enums/domain-transfer-status-status';
|
package/types/models.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ import { ProxyRuleDeploymentResourceType } from "./enums/proxy-rule-deployment-r
|
|
|
12
12
|
import { ProxyRuleStatus } from "./enums/proxy-rule-status";
|
|
13
13
|
import { MessageStatus } from "./enums/message-status";
|
|
14
14
|
import { BillingPlanGroup } from "./enums/billing-plan-group";
|
|
15
|
+
import { DomainTransferStatusStatus } from "./enums/domain-transfer-status-status";
|
|
15
16
|
/**
|
|
16
17
|
* Appwrite Models
|
|
17
18
|
*/
|
|
@@ -2531,7 +2532,7 @@ export declare namespace Models {
|
|
|
2531
2532
|
*/
|
|
2532
2533
|
$id: string;
|
|
2533
2534
|
/**
|
|
2534
|
-
* Row
|
|
2535
|
+
* Row sequence ID.
|
|
2535
2536
|
*/
|
|
2536
2537
|
$sequence: number;
|
|
2537
2538
|
/**
|
|
@@ -2568,7 +2569,7 @@ export declare namespace Models {
|
|
|
2568
2569
|
*/
|
|
2569
2570
|
$id: string;
|
|
2570
2571
|
/**
|
|
2571
|
-
* Document
|
|
2572
|
+
* Document sequence ID.
|
|
2572
2573
|
*/
|
|
2573
2574
|
$sequence: number;
|
|
2574
2575
|
/**
|
|
@@ -3884,6 +3885,14 @@ export declare namespace Models {
|
|
|
3884
3885
|
* VCS (Version Control System) repository's default branch name.
|
|
3885
3886
|
*/
|
|
3886
3887
|
defaultBranch: string;
|
|
3888
|
+
/**
|
|
3889
|
+
* VCS (Version Control System) installation ID.
|
|
3890
|
+
*/
|
|
3891
|
+
providerInstallationId: string;
|
|
3892
|
+
/**
|
|
3893
|
+
* Is VCS (Version Control System) repository authorized for the installation?
|
|
3894
|
+
*/
|
|
3895
|
+
authorized: boolean;
|
|
3887
3896
|
/**
|
|
3888
3897
|
* Last commit date in ISO 8601 format.
|
|
3889
3898
|
*/
|
|
@@ -3921,6 +3930,14 @@ export declare namespace Models {
|
|
|
3921
3930
|
* VCS (Version Control System) repository's default branch name.
|
|
3922
3931
|
*/
|
|
3923
3932
|
defaultBranch: string;
|
|
3933
|
+
/**
|
|
3934
|
+
* VCS (Version Control System) installation ID.
|
|
3935
|
+
*/
|
|
3936
|
+
providerInstallationId: string;
|
|
3937
|
+
/**
|
|
3938
|
+
* Is VCS (Version Control System) repository authorized for the installation?
|
|
3939
|
+
*/
|
|
3940
|
+
authorized: boolean;
|
|
3924
3941
|
/**
|
|
3925
3942
|
* Last commit date in ISO 8601 format.
|
|
3926
3943
|
*/
|
|
@@ -3962,6 +3979,14 @@ export declare namespace Models {
|
|
|
3962
3979
|
* VCS (Version Control System) repository's default branch name.
|
|
3963
3980
|
*/
|
|
3964
3981
|
defaultBranch: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* VCS (Version Control System) installation ID.
|
|
3984
|
+
*/
|
|
3985
|
+
providerInstallationId: string;
|
|
3986
|
+
/**
|
|
3987
|
+
* Is VCS (Version Control System) repository authorized for the installation?
|
|
3988
|
+
*/
|
|
3989
|
+
authorized: boolean;
|
|
3965
3990
|
/**
|
|
3966
3991
|
* Last commit date in ISO 8601 format.
|
|
3967
3992
|
*/
|
|
@@ -4609,6 +4634,10 @@ export declare namespace Models {
|
|
|
4609
4634
|
* Project blocks information
|
|
4610
4635
|
*/
|
|
4611
4636
|
blocks: Block[];
|
|
4637
|
+
/**
|
|
4638
|
+
* Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
|
|
4639
|
+
*/
|
|
4640
|
+
consoleAccessedAt: string;
|
|
4612
4641
|
};
|
|
4613
4642
|
/**
|
|
4614
4643
|
* Webhook
|
|
@@ -6219,6 +6248,50 @@ export declare namespace Models {
|
|
|
6219
6248
|
* Comma-separated list of nameservers.
|
|
6220
6249
|
*/
|
|
6221
6250
|
_APP_DOMAINS_NAMESERVERS: string;
|
|
6251
|
+
/**
|
|
6252
|
+
* Database adapter in use.
|
|
6253
|
+
*/
|
|
6254
|
+
_APP_DB_ADAPTER: string;
|
|
6255
|
+
/**
|
|
6256
|
+
* Whether the database adapter supports relationships.
|
|
6257
|
+
*/
|
|
6258
|
+
supportForRelationships: boolean;
|
|
6259
|
+
/**
|
|
6260
|
+
* Whether the database adapter supports operators.
|
|
6261
|
+
*/
|
|
6262
|
+
supportForOperators: boolean;
|
|
6263
|
+
/**
|
|
6264
|
+
* Whether the database adapter supports spatial attributes.
|
|
6265
|
+
*/
|
|
6266
|
+
supportForSpatials: boolean;
|
|
6267
|
+
/**
|
|
6268
|
+
* Whether the database adapter supports spatial indexes on nullable columns.
|
|
6269
|
+
*/
|
|
6270
|
+
supportForSpatialIndexNull: boolean;
|
|
6271
|
+
/**
|
|
6272
|
+
* Whether the database adapter supports fulltext wildcard search.
|
|
6273
|
+
*/
|
|
6274
|
+
supportForFulltextWildcard: boolean;
|
|
6275
|
+
/**
|
|
6276
|
+
* Whether the database adapter supports multiple fulltext indexes per collection.
|
|
6277
|
+
*/
|
|
6278
|
+
supportForMultipleFulltextIndexes: boolean;
|
|
6279
|
+
/**
|
|
6280
|
+
* Whether the database adapter supports resizing attributes.
|
|
6281
|
+
*/
|
|
6282
|
+
supportForAttributeResizing: boolean;
|
|
6283
|
+
/**
|
|
6284
|
+
* Whether the database adapter supports fixed schemas with row width limits.
|
|
6285
|
+
*/
|
|
6286
|
+
supportForSchemas: boolean;
|
|
6287
|
+
/**
|
|
6288
|
+
* Maximum index length supported by the database adapter.
|
|
6289
|
+
*/
|
|
6290
|
+
maxIndexLength: number;
|
|
6291
|
+
/**
|
|
6292
|
+
* Whether the database adapter uses integer sequence IDs.
|
|
6293
|
+
*/
|
|
6294
|
+
supportForIntegerIds: boolean;
|
|
6222
6295
|
};
|
|
6223
6296
|
/**
|
|
6224
6297
|
* MFA Challenge
|
|
@@ -6619,6 +6692,10 @@ export declare namespace Models {
|
|
|
6619
6692
|
* Number of functions to be migrated.
|
|
6620
6693
|
*/
|
|
6621
6694
|
function: number;
|
|
6695
|
+
/**
|
|
6696
|
+
* Number of sites to be migrated.
|
|
6697
|
+
*/
|
|
6698
|
+
site: number;
|
|
6622
6699
|
/**
|
|
6623
6700
|
* Size of files to be migrated in mb.
|
|
6624
6701
|
*/
|
|
@@ -7154,6 +7231,10 @@ export declare namespace Models {
|
|
|
7154
7231
|
* Log days
|
|
7155
7232
|
*/
|
|
7156
7233
|
logs: number;
|
|
7234
|
+
/**
|
|
7235
|
+
* Number of days of console inactivity before a project is paused. 0 means pausing is disabled.
|
|
7236
|
+
*/
|
|
7237
|
+
projectInactivityDays: number;
|
|
7157
7238
|
/**
|
|
7158
7239
|
* Alert threshold percentage
|
|
7159
7240
|
*/
|
|
@@ -8342,6 +8423,10 @@ export declare namespace Models {
|
|
|
8342
8423
|
* Domain registrar (e.g. "appwrite" or "third_party").
|
|
8343
8424
|
*/
|
|
8344
8425
|
registrar: string;
|
|
8426
|
+
/**
|
|
8427
|
+
* Payment status for domain purchase.
|
|
8428
|
+
*/
|
|
8429
|
+
paymentStatus: string;
|
|
8345
8430
|
/**
|
|
8346
8431
|
* Nameservers setting. "Appwrite" or empty string.
|
|
8347
8432
|
*/
|
|
@@ -8359,7 +8444,7 @@ export declare namespace Models {
|
|
|
8359
8444
|
*/
|
|
8360
8445
|
autoRenewal: boolean;
|
|
8361
8446
|
/**
|
|
8362
|
-
* Renewal price (in
|
|
8447
|
+
* Renewal price (in cents).
|
|
8363
8448
|
*/
|
|
8364
8449
|
renewalPrice: number;
|
|
8365
8450
|
/**
|
|
@@ -8370,6 +8455,10 @@ export declare namespace Models {
|
|
|
8370
8455
|
* Dns records
|
|
8371
8456
|
*/
|
|
8372
8457
|
dnsRecords: DnsRecord[];
|
|
8458
|
+
/**
|
|
8459
|
+
* Domain transfer status (e.g., "pending", "completed", "failed").
|
|
8460
|
+
*/
|
|
8461
|
+
transferStatus: string;
|
|
8373
8462
|
};
|
|
8374
8463
|
/**
|
|
8375
8464
|
* DNSRecord
|
|
@@ -8618,6 +8707,10 @@ export declare namespace Models {
|
|
|
8618
8707
|
* Price period in years.
|
|
8619
8708
|
*/
|
|
8620
8709
|
periodYears: number;
|
|
8710
|
+
/**
|
|
8711
|
+
* Whether the domain is a premium domain.
|
|
8712
|
+
*/
|
|
8713
|
+
premium: boolean;
|
|
8621
8714
|
};
|
|
8622
8715
|
/**
|
|
8623
8716
|
* DomainSuggestion
|
|
@@ -8640,6 +8733,32 @@ export declare namespace Models {
|
|
|
8640
8733
|
*/
|
|
8641
8734
|
available: boolean;
|
|
8642
8735
|
};
|
|
8736
|
+
/**
|
|
8737
|
+
* domainTransferOut
|
|
8738
|
+
*/
|
|
8739
|
+
export type DomainTransferOut = {
|
|
8740
|
+
/**
|
|
8741
|
+
* Domain transfer authorization code.
|
|
8742
|
+
*/
|
|
8743
|
+
authCode: string;
|
|
8744
|
+
};
|
|
8745
|
+
/**
|
|
8746
|
+
* domainTransferStatus
|
|
8747
|
+
*/
|
|
8748
|
+
export type DomainTransferStatus = {
|
|
8749
|
+
/**
|
|
8750
|
+
* Transfer status.
|
|
8751
|
+
*/
|
|
8752
|
+
status: DomainTransferStatusStatus;
|
|
8753
|
+
/**
|
|
8754
|
+
* Additional transfer status information.
|
|
8755
|
+
*/
|
|
8756
|
+
reason: string;
|
|
8757
|
+
/**
|
|
8758
|
+
* Transfer status timestamp in ISO 8601 format.
|
|
8759
|
+
*/
|
|
8760
|
+
timestamp: string;
|
|
8761
|
+
};
|
|
8643
8762
|
/**
|
|
8644
8763
|
* Activity event list
|
|
8645
8764
|
*/
|
package/types/query.d.ts
CHANGED
|
@@ -198,12 +198,34 @@ export declare class Query {
|
|
|
198
198
|
static offset: (offset: number) => string;
|
|
199
199
|
/**
|
|
200
200
|
* Filter resources where attribute contains the specified value.
|
|
201
|
+
* For string attributes, checks if the string contains the substring.
|
|
201
202
|
*
|
|
203
|
+
* Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
|
|
202
204
|
* @param {string} attribute
|
|
203
205
|
* @param {string | string[]} value
|
|
204
206
|
* @returns {string}
|
|
205
207
|
*/
|
|
206
208
|
static contains: (attribute: string, value: string | any[]) => string;
|
|
209
|
+
/**
|
|
210
|
+
* Filter resources where attribute contains ANY of the specified values.
|
|
211
|
+
* For array and relationship attributes, matches documents where the attribute
|
|
212
|
+
* contains at least one of the given values.
|
|
213
|
+
*
|
|
214
|
+
* @param {string} attribute
|
|
215
|
+
* @param {any[]} value
|
|
216
|
+
* @returns {string}
|
|
217
|
+
*/
|
|
218
|
+
static containsAny: (attribute: string, value: any[]) => string;
|
|
219
|
+
/**
|
|
220
|
+
* Filter resources where attribute contains ALL of the specified values.
|
|
221
|
+
* For array and relationship attributes, matches documents where the attribute
|
|
222
|
+
* contains every one of the given values.
|
|
223
|
+
*
|
|
224
|
+
* @param {string} attribute
|
|
225
|
+
* @param {any[]} value
|
|
226
|
+
* @returns {string}
|
|
227
|
+
*/
|
|
228
|
+
static containsAll: (attribute: string, value: any[]) => string;
|
|
207
229
|
/**
|
|
208
230
|
* Filter resources where attribute does not contain the specified value.
|
|
209
231
|
*
|