node-appwrite 23.1.0 → 24.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/client.d.mts +2 -1
- package/dist/client.d.ts +2 -1
- package/dist/client.js +7 -9
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +6 -8
- package/dist/client.mjs.map +1 -1
- package/dist/enums/adapter.js +1 -1
- package/dist/enums/adapter.js.map +1 -1
- package/dist/enums/adapter.mjs +1 -1
- package/dist/enums/adapter.mjs.map +1 -1
- package/dist/enums/attribute-status.js +1 -1
- package/dist/enums/attribute-status.js.map +1 -1
- package/dist/enums/attribute-status.mjs +1 -1
- package/dist/enums/attribute-status.mjs.map +1 -1
- package/dist/enums/authentication-factor.js +1 -1
- package/dist/enums/authentication-factor.js.map +1 -1
- package/dist/enums/authentication-factor.mjs +1 -1
- package/dist/enums/authentication-factor.mjs.map +1 -1
- package/dist/enums/authenticator-type.js +1 -1
- package/dist/enums/authenticator-type.js.map +1 -1
- package/dist/enums/authenticator-type.mjs +1 -1
- package/dist/enums/authenticator-type.mjs.map +1 -1
- package/dist/enums/backup-services.js +1 -1
- package/dist/enums/backup-services.js.map +1 -1
- package/dist/enums/backup-services.mjs +1 -1
- package/dist/enums/backup-services.mjs.map +1 -1
- package/dist/enums/browser-permission.js +1 -1
- package/dist/enums/browser-permission.js.map +1 -1
- package/dist/enums/browser-permission.mjs +1 -1
- package/dist/enums/browser-permission.mjs.map +1 -1
- package/dist/enums/browser.js +1 -1
- package/dist/enums/browser.js.map +1 -1
- package/dist/enums/browser.mjs +1 -1
- package/dist/enums/browser.mjs.map +1 -1
- package/dist/enums/build-runtime.d.mts +3 -1
- package/dist/enums/build-runtime.d.ts +3 -1
- package/dist/enums/build-runtime.js +3 -1
- package/dist/enums/build-runtime.js.map +1 -1
- package/dist/enums/build-runtime.mjs +3 -1
- package/dist/enums/build-runtime.mjs.map +1 -1
- package/dist/enums/column-status.js +1 -1
- package/dist/enums/column-status.js.map +1 -1
- package/dist/enums/column-status.mjs +1 -1
- package/dist/enums/column-status.mjs.map +1 -1
- package/dist/enums/compression.js +1 -1
- package/dist/enums/compression.js.map +1 -1
- package/dist/enums/compression.mjs +1 -1
- package/dist/enums/compression.mjs.map +1 -1
- package/dist/enums/credit-card.js +1 -1
- package/dist/enums/credit-card.js.map +1 -1
- package/dist/enums/credit-card.mjs +1 -1
- package/dist/enums/credit-card.mjs.map +1 -1
- package/dist/enums/database-type.js +1 -1
- package/dist/enums/database-type.js.map +1 -1
- package/dist/enums/database-type.mjs +1 -1
- package/dist/enums/database-type.mjs.map +1 -1
- package/dist/enums/databases-index-type.js +1 -1
- package/dist/enums/databases-index-type.js.map +1 -1
- package/dist/enums/databases-index-type.mjs +1 -1
- package/dist/enums/databases-index-type.mjs.map +1 -1
- package/dist/enums/deployment-download-type.js +1 -1
- package/dist/enums/deployment-download-type.js.map +1 -1
- package/dist/enums/deployment-download-type.mjs +1 -1
- package/dist/enums/deployment-download-type.mjs.map +1 -1
- package/dist/enums/deployment-status.js +1 -1
- package/dist/enums/deployment-status.js.map +1 -1
- package/dist/enums/deployment-status.mjs +1 -1
- package/dist/enums/deployment-status.mjs.map +1 -1
- package/dist/enums/execution-method.js +1 -1
- package/dist/enums/execution-method.js.map +1 -1
- package/dist/enums/execution-method.mjs +1 -1
- package/dist/enums/execution-method.mjs.map +1 -1
- package/dist/enums/execution-status.js +1 -1
- package/dist/enums/execution-status.js.map +1 -1
- package/dist/enums/execution-status.mjs +1 -1
- package/dist/enums/execution-status.mjs.map +1 -1
- package/dist/enums/execution-trigger.js +1 -1
- package/dist/enums/execution-trigger.js.map +1 -1
- package/dist/enums/execution-trigger.mjs +1 -1
- package/dist/enums/execution-trigger.mjs.map +1 -1
- package/dist/enums/flag.js +1 -1
- package/dist/enums/flag.js.map +1 -1
- package/dist/enums/flag.mjs +1 -1
- package/dist/enums/flag.mjs.map +1 -1
- package/dist/enums/framework.js +1 -1
- package/dist/enums/framework.js.map +1 -1
- package/dist/enums/framework.mjs +1 -1
- package/dist/enums/framework.mjs.map +1 -1
- package/dist/enums/health-antivirus-status.js +1 -1
- package/dist/enums/health-antivirus-status.js.map +1 -1
- package/dist/enums/health-antivirus-status.mjs +1 -1
- package/dist/enums/health-antivirus-status.mjs.map +1 -1
- package/dist/enums/health-check-status.js +1 -1
- package/dist/enums/health-check-status.js.map +1 -1
- package/dist/enums/health-check-status.mjs +1 -1
- package/dist/enums/health-check-status.mjs.map +1 -1
- package/dist/enums/image-format.js +1 -1
- package/dist/enums/image-format.js.map +1 -1
- package/dist/enums/image-format.mjs +1 -1
- package/dist/enums/image-format.mjs.map +1 -1
- package/dist/enums/image-gravity.js +1 -1
- package/dist/enums/image-gravity.js.map +1 -1
- package/dist/enums/image-gravity.mjs +1 -1
- package/dist/enums/image-gravity.mjs.map +1 -1
- package/dist/enums/index-status.js +1 -1
- package/dist/enums/index-status.js.map +1 -1
- package/dist/enums/index-status.mjs +1 -1
- package/dist/enums/index-status.mjs.map +1 -1
- package/dist/enums/message-priority.js +1 -1
- package/dist/enums/message-priority.js.map +1 -1
- package/dist/enums/message-priority.mjs +1 -1
- package/dist/enums/message-priority.mjs.map +1 -1
- package/dist/enums/message-status.js +1 -1
- package/dist/enums/message-status.js.map +1 -1
- package/dist/enums/message-status.mjs +1 -1
- package/dist/enums/message-status.mjs.map +1 -1
- package/dist/enums/messaging-provider-type.js +1 -1
- package/dist/enums/messaging-provider-type.js.map +1 -1
- package/dist/enums/messaging-provider-type.mjs +1 -1
- package/dist/enums/messaging-provider-type.mjs.map +1 -1
- package/dist/enums/name.js +1 -1
- package/dist/enums/name.js.map +1 -1
- package/dist/enums/name.mjs +1 -1
- package/dist/enums/name.mjs.map +1 -1
- package/dist/enums/o-auth-provider.d.mts +1 -0
- package/dist/enums/o-auth-provider.d.ts +1 -0
- package/dist/enums/o-auth-provider.js +2 -1
- package/dist/enums/o-auth-provider.js.map +1 -1
- package/dist/enums/o-auth-provider.mjs +2 -1
- package/dist/enums/o-auth-provider.mjs.map +1 -1
- package/dist/enums/order-by.js +1 -1
- package/dist/enums/order-by.js.map +1 -1
- package/dist/enums/order-by.mjs +1 -1
- package/dist/enums/order-by.mjs.map +1 -1
- package/dist/enums/password-hash.js +1 -1
- package/dist/enums/password-hash.js.map +1 -1
- package/dist/enums/password-hash.mjs +1 -1
- package/dist/enums/password-hash.mjs.map +1 -1
- package/dist/enums/platform-type.d.mts +9 -0
- package/dist/enums/platform-type.d.ts +9 -0
- package/dist/enums/platform-type.js +14 -0
- package/dist/enums/platform-type.js.map +1 -0
- package/dist/enums/platform-type.mjs +13 -0
- package/dist/enums/platform-type.mjs.map +1 -0
- package/dist/enums/protocol-id.d.mts +7 -0
- package/dist/enums/protocol-id.d.ts +7 -0
- package/dist/enums/protocol-id.js +12 -0
- package/dist/enums/protocol-id.js.map +1 -0
- package/dist/enums/protocol-id.mjs +11 -0
- package/dist/enums/protocol-id.mjs.map +1 -0
- package/dist/enums/relation-mutate.js +1 -1
- package/dist/enums/relation-mutate.js.map +1 -1
- package/dist/enums/relation-mutate.mjs +1 -1
- package/dist/enums/relation-mutate.mjs.map +1 -1
- package/dist/enums/relationship-type.js +1 -1
- package/dist/enums/relationship-type.js.map +1 -1
- package/dist/enums/relationship-type.mjs +1 -1
- package/dist/enums/relationship-type.mjs.map +1 -1
- package/dist/enums/runtime.d.mts +3 -1
- package/dist/enums/runtime.d.ts +3 -1
- package/dist/enums/runtime.js +3 -1
- package/dist/enums/runtime.js.map +1 -1
- package/dist/enums/runtime.mjs +3 -1
- package/dist/enums/runtime.mjs.map +1 -1
- package/dist/enums/scopes.d.mts +4 -0
- package/dist/enums/scopes.d.ts +4 -0
- package/dist/enums/scopes.js +5 -1
- package/dist/enums/scopes.js.map +1 -1
- package/dist/enums/scopes.mjs +5 -1
- package/dist/enums/scopes.mjs.map +1 -1
- package/dist/enums/service-id.d.mts +21 -0
- package/dist/enums/service-id.d.ts +21 -0
- package/dist/enums/service-id.js +26 -0
- package/dist/enums/service-id.js.map +1 -0
- package/dist/enums/service-id.mjs +25 -0
- package/dist/enums/service-id.mjs.map +1 -0
- package/dist/enums/smtp-encryption.js +1 -1
- package/dist/enums/smtp-encryption.js.map +1 -1
- package/dist/enums/smtp-encryption.mjs +1 -1
- package/dist/enums/smtp-encryption.mjs.map +1 -1
- package/dist/enums/tables-db-index-type.js +1 -1
- package/dist/enums/tables-db-index-type.js.map +1 -1
- package/dist/enums/tables-db-index-type.mjs +1 -1
- package/dist/enums/tables-db-index-type.mjs.map +1 -1
- package/dist/enums/template-reference-type.js +1 -1
- package/dist/enums/template-reference-type.js.map +1 -1
- package/dist/enums/template-reference-type.mjs +1 -1
- package/dist/enums/template-reference-type.mjs.map +1 -1
- package/dist/enums/theme.js +1 -1
- package/dist/enums/theme.js.map +1 -1
- package/dist/enums/theme.mjs +1 -1
- package/dist/enums/theme.mjs.map +1 -1
- package/dist/enums/timezone.js +1 -1
- package/dist/enums/timezone.js.map +1 -1
- package/dist/enums/timezone.mjs +1 -1
- package/dist/enums/timezone.mjs.map +1 -1
- package/dist/enums/vcs-reference-type.js +1 -1
- package/dist/enums/vcs-reference-type.js.map +1 -1
- package/dist/enums/vcs-reference-type.mjs +1 -1
- package/dist/enums/vcs-reference-type.mjs.map +1 -1
- package/dist/id.js +1 -1
- package/dist/id.js.map +1 -1
- package/dist/id.mjs +1 -1
- package/dist/id.mjs.map +1 -1
- package/dist/index.d.mts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +84 -69
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +4 -1
- package/dist/index.mjs.map +1 -1
- package/dist/inputFile.js +1 -1
- package/dist/inputFile.js.map +1 -1
- package/dist/inputFile.mjs +1 -1
- package/dist/inputFile.mjs.map +1 -1
- package/dist/models.d.mts +678 -7
- package/dist/models.d.ts +678 -7
- package/dist/models.js +1 -1
- package/dist/models.js.map +1 -1
- package/dist/models.mjs +1 -1
- package/dist/models.mjs.map +1 -1
- package/dist/operator.d.mts +1 -1
- package/dist/operator.d.ts +1 -1
- package/dist/operator.js +1 -1
- package/dist/operator.js.map +1 -1
- package/dist/operator.mjs +1 -1
- package/dist/operator.mjs.map +1 -1
- package/dist/permission.js +1 -1
- package/dist/permission.js.map +1 -1
- package/dist/permission.mjs +1 -1
- package/dist/permission.mjs.map +1 -1
- package/dist/query.d.mts +1 -1
- package/dist/query.d.ts +1 -1
- package/dist/query.js +1 -1
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +1 -1
- package/dist/query.mjs.map +1 -1
- package/dist/role.js +1 -1
- package/dist/role.js.map +1 -1
- package/dist/role.mjs +1 -1
- package/dist/role.mjs.map +1 -1
- package/dist/services/account.d.mts +3 -2
- package/dist/services/account.d.ts +3 -2
- package/dist/services/account.js +1 -1
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +1 -1
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/activities.d.mts +1 -0
- package/dist/services/activities.d.ts +1 -0
- package/dist/services/activities.js +1 -1
- package/dist/services/activities.js.map +1 -1
- package/dist/services/activities.mjs +1 -1
- package/dist/services/activities.mjs.map +1 -1
- package/dist/services/avatars.d.mts +1 -0
- package/dist/services/avatars.d.ts +1 -0
- package/dist/services/avatars.js +1 -1
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs +1 -1
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/backups.d.mts +1 -0
- package/dist/services/backups.d.ts +1 -0
- package/dist/services/backups.js +1 -1
- package/dist/services/backups.js.map +1 -1
- package/dist/services/backups.mjs +1 -1
- package/dist/services/backups.mjs.map +1 -1
- package/dist/services/databases.d.mts +7 -3
- package/dist/services/databases.d.ts +7 -3
- package/dist/services/databases.js +7 -2
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +7 -2
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +1 -0
- package/dist/services/functions.d.ts +1 -0
- package/dist/services/functions.js +1 -1
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs +1 -1
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/graphql.d.mts +1 -0
- package/dist/services/graphql.d.ts +1 -0
- package/dist/services/graphql.js +1 -1
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/graphql.mjs +1 -1
- package/dist/services/graphql.mjs.map +1 -1
- package/dist/services/health.d.mts +3 -0
- package/dist/services/health.d.ts +3 -0
- package/dist/services/health.js +1 -1
- package/dist/services/health.js.map +1 -1
- package/dist/services/health.mjs +1 -1
- package/dist/services/health.mjs.map +1 -1
- package/dist/services/locale.d.mts +1 -0
- package/dist/services/locale.d.ts +1 -0
- package/dist/services/locale.js +1 -1
- package/dist/services/locale.js.map +1 -1
- package/dist/services/locale.mjs +1 -1
- package/dist/services/locale.mjs.map +1 -1
- package/dist/services/messaging.d.mts +1 -0
- package/dist/services/messaging.d.ts +1 -0
- package/dist/services/messaging.js +1 -1
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs +1 -1
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/project.d.mts +493 -0
- package/dist/services/project.d.ts +493 -0
- package/dist/services/project.js +788 -1
- package/dist/services/project.js.map +1 -1
- package/dist/services/project.mjs +788 -1
- package/dist/services/project.mjs.map +1 -1
- package/dist/services/sites.d.mts +1 -0
- package/dist/services/sites.d.ts +1 -0
- package/dist/services/sites.js +1 -1
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs +1 -1
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +1 -0
- package/dist/services/storage.d.ts +1 -0
- package/dist/services/storage.js +1 -1
- package/dist/services/storage.js.map +1 -1
- package/dist/services/storage.mjs +1 -1
- package/dist/services/storage.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +7 -3
- package/dist/services/tables-db.d.ts +7 -3
- package/dist/services/tables-db.js +7 -2
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs +7 -2
- package/dist/services/tables-db.mjs.map +1 -1
- package/dist/services/teams.d.mts +1 -0
- package/dist/services/teams.d.ts +1 -0
- package/dist/services/teams.js +1 -1
- package/dist/services/teams.js.map +1 -1
- package/dist/services/teams.mjs +1 -1
- package/dist/services/teams.mjs.map +1 -1
- package/dist/services/tokens.d.mts +1 -0
- package/dist/services/tokens.d.ts +1 -0
- package/dist/services/tokens.js +1 -1
- package/dist/services/tokens.js.map +1 -1
- package/dist/services/tokens.mjs +1 -1
- package/dist/services/tokens.mjs.map +1 -1
- package/dist/services/users.d.mts +1 -0
- package/dist/services/users.d.ts +1 -0
- package/dist/services/users.js +1 -1
- package/dist/services/users.js.map +1 -1
- package/dist/services/users.mjs +1 -1
- package/dist/services/users.mjs.map +1 -1
- package/dist/services/webhooks.d.mts +33 -26
- package/dist/services/webhooks.d.ts +33 -26
- package/dist/services/webhooks.js +38 -28
- package/dist/services/webhooks.js.map +1 -1
- package/dist/services/webhooks.mjs +38 -28
- package/dist/services/webhooks.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { Client } from '../client.js';
|
|
2
2
|
import { Models } from '../models.js';
|
|
3
|
+
import { Scopes } from '../enums/scopes.js';
|
|
4
|
+
import { ProtocolId } from '../enums/protocol-id.js';
|
|
5
|
+
import { ServiceId } from '../enums/service-id.js';
|
|
3
6
|
import '../query.js';
|
|
4
7
|
import '../enums/database-type.js';
|
|
5
8
|
import '../enums/attribute-status.js';
|
|
@@ -8,6 +11,7 @@ import '../enums/index-status.js';
|
|
|
8
11
|
import '../enums/deployment-status.js';
|
|
9
12
|
import '../enums/execution-trigger.js';
|
|
10
13
|
import '../enums/execution-status.js';
|
|
14
|
+
import '../enums/platform-type.js';
|
|
11
15
|
import '../enums/health-antivirus-status.js';
|
|
12
16
|
import '../enums/health-check-status.js';
|
|
13
17
|
import '../enums/message-status.js';
|
|
@@ -15,6 +19,495 @@ import '../enums/message-status.js';
|
|
|
15
19
|
declare class Project {
|
|
16
20
|
client: Client;
|
|
17
21
|
constructor(client: Client);
|
|
22
|
+
/**
|
|
23
|
+
* Get a list of all API keys from the current project.
|
|
24
|
+
*
|
|
25
|
+
* @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. You may filter on the following attributes: expire, accessedAt, name, scopes
|
|
26
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
27
|
+
* @throws {AppwriteException}
|
|
28
|
+
* @returns {Promise<Models.KeyList>}
|
|
29
|
+
*/
|
|
30
|
+
listKeys(params?: {
|
|
31
|
+
queries?: string[];
|
|
32
|
+
total?: boolean;
|
|
33
|
+
}): Promise<Models.KeyList>;
|
|
34
|
+
/**
|
|
35
|
+
* Get a list of all API keys from the current project.
|
|
36
|
+
*
|
|
37
|
+
* @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. You may filter on the following attributes: expire, accessedAt, name, scopes
|
|
38
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
39
|
+
* @throws {AppwriteException}
|
|
40
|
+
* @returns {Promise<Models.KeyList>}
|
|
41
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
|
+
*/
|
|
43
|
+
listKeys(queries?: string[], total?: boolean): Promise<Models.KeyList>;
|
|
44
|
+
/**
|
|
45
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
46
|
+
*
|
|
47
|
+
* @param {string} params.keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
48
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
49
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
50
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
51
|
+
* @throws {AppwriteException}
|
|
52
|
+
* @returns {Promise<Models.Key>}
|
|
53
|
+
*/
|
|
54
|
+
createKey(params: {
|
|
55
|
+
keyId: string;
|
|
56
|
+
name: string;
|
|
57
|
+
scopes: Scopes[];
|
|
58
|
+
expire?: string;
|
|
59
|
+
}): Promise<Models.Key>;
|
|
60
|
+
/**
|
|
61
|
+
* Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
|
62
|
+
*
|
|
63
|
+
* @param {string} keyId - Key ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
64
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
65
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
66
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
67
|
+
* @throws {AppwriteException}
|
|
68
|
+
* @returns {Promise<Models.Key>}
|
|
69
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
70
|
+
*/
|
|
71
|
+
createKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
72
|
+
/**
|
|
73
|
+
* Get a key by its unique ID.
|
|
74
|
+
*
|
|
75
|
+
* @param {string} params.keyId - Key ID.
|
|
76
|
+
* @throws {AppwriteException}
|
|
77
|
+
* @returns {Promise<Models.Key>}
|
|
78
|
+
*/
|
|
79
|
+
getKey(params: {
|
|
80
|
+
keyId: string;
|
|
81
|
+
}): Promise<Models.Key>;
|
|
82
|
+
/**
|
|
83
|
+
* Get a key by its unique ID.
|
|
84
|
+
*
|
|
85
|
+
* @param {string} keyId - Key ID.
|
|
86
|
+
* @throws {AppwriteException}
|
|
87
|
+
* @returns {Promise<Models.Key>}
|
|
88
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
89
|
+
*/
|
|
90
|
+
getKey(keyId: string): Promise<Models.Key>;
|
|
91
|
+
/**
|
|
92
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
93
|
+
*
|
|
94
|
+
* @param {string} params.keyId - Key ID.
|
|
95
|
+
* @param {string} params.name - Key name. Max length: 128 chars.
|
|
96
|
+
* @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
97
|
+
* @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
98
|
+
* @throws {AppwriteException}
|
|
99
|
+
* @returns {Promise<Models.Key>}
|
|
100
|
+
*/
|
|
101
|
+
updateKey(params: {
|
|
102
|
+
keyId: string;
|
|
103
|
+
name: string;
|
|
104
|
+
scopes: Scopes[];
|
|
105
|
+
expire?: string;
|
|
106
|
+
}): Promise<Models.Key>;
|
|
107
|
+
/**
|
|
108
|
+
* Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
|
109
|
+
*
|
|
110
|
+
* @param {string} keyId - Key ID.
|
|
111
|
+
* @param {string} name - Key name. Max length: 128 chars.
|
|
112
|
+
* @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
|
|
113
|
+
* @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
114
|
+
* @throws {AppwriteException}
|
|
115
|
+
* @returns {Promise<Models.Key>}
|
|
116
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
117
|
+
*/
|
|
118
|
+
updateKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
|
|
119
|
+
/**
|
|
120
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
121
|
+
*
|
|
122
|
+
* @param {string} params.keyId - Key ID.
|
|
123
|
+
* @throws {AppwriteException}
|
|
124
|
+
* @returns {Promise<{}>}
|
|
125
|
+
*/
|
|
126
|
+
deleteKey(params: {
|
|
127
|
+
keyId: string;
|
|
128
|
+
}): Promise<{}>;
|
|
129
|
+
/**
|
|
130
|
+
* Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
|
131
|
+
*
|
|
132
|
+
* @param {string} keyId - Key ID.
|
|
133
|
+
* @throws {AppwriteException}
|
|
134
|
+
* @returns {Promise<{}>}
|
|
135
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
136
|
+
*/
|
|
137
|
+
deleteKey(keyId: string): Promise<{}>;
|
|
138
|
+
/**
|
|
139
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
140
|
+
*
|
|
141
|
+
* @param {string[]} params.labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
142
|
+
* @throws {AppwriteException}
|
|
143
|
+
* @returns {Promise<Models.Project>}
|
|
144
|
+
*/
|
|
145
|
+
updateLabels(params: {
|
|
146
|
+
labels: string[];
|
|
147
|
+
}): Promise<Models.Project>;
|
|
148
|
+
/**
|
|
149
|
+
* Update the project labels. Labels can be used to easily filter projects in an organization.
|
|
150
|
+
*
|
|
151
|
+
* @param {string[]} labels - Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
152
|
+
* @throws {AppwriteException}
|
|
153
|
+
* @returns {Promise<Models.Project>}
|
|
154
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
155
|
+
*/
|
|
156
|
+
updateLabels(labels: string[]): Promise<Models.Project>;
|
|
157
|
+
/**
|
|
158
|
+
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
159
|
+
*
|
|
160
|
+
* @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. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName
|
|
161
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
162
|
+
* @throws {AppwriteException}
|
|
163
|
+
* @returns {Promise<Models.PlatformList>}
|
|
164
|
+
*/
|
|
165
|
+
listPlatforms(params?: {
|
|
166
|
+
queries?: string[];
|
|
167
|
+
total?: boolean;
|
|
168
|
+
}): Promise<Models.PlatformList>;
|
|
169
|
+
/**
|
|
170
|
+
* Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
|
171
|
+
*
|
|
172
|
+
* @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. You may filter on the following attributes: type, name, hostname, bundleIdentifier, applicationId, packageIdentifierName, packageName
|
|
173
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
174
|
+
* @throws {AppwriteException}
|
|
175
|
+
* @returns {Promise<Models.PlatformList>}
|
|
176
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
177
|
+
*/
|
|
178
|
+
listPlatforms(queries?: string[], total?: boolean): Promise<Models.PlatformList>;
|
|
179
|
+
/**
|
|
180
|
+
* Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.
|
|
181
|
+
*
|
|
182
|
+
* @param {string} params.platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
183
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
184
|
+
* @param {string} params.applicationId - Android application ID. Max length: 256 chars.
|
|
185
|
+
* @throws {AppwriteException}
|
|
186
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
187
|
+
*/
|
|
188
|
+
createAndroidPlatform(params: {
|
|
189
|
+
platformId: string;
|
|
190
|
+
name: string;
|
|
191
|
+
applicationId: string;
|
|
192
|
+
}): Promise<Models.PlatformAndroid>;
|
|
193
|
+
/**
|
|
194
|
+
* Create a new Android platform for your project. Use this endpoint to register a new Android platform where your users will run your application which will interact with the Appwrite API.
|
|
195
|
+
*
|
|
196
|
+
* @param {string} platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
197
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
198
|
+
* @param {string} applicationId - Android application ID. Max length: 256 chars.
|
|
199
|
+
* @throws {AppwriteException}
|
|
200
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
201
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
202
|
+
*/
|
|
203
|
+
createAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
|
|
204
|
+
/**
|
|
205
|
+
* Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
|
|
206
|
+
*
|
|
207
|
+
* @param {string} params.platformId - Platform ID.
|
|
208
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
209
|
+
* @param {string} params.applicationId - Android application ID. Max length: 256 chars.
|
|
210
|
+
* @throws {AppwriteException}
|
|
211
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
212
|
+
*/
|
|
213
|
+
updateAndroidPlatform(params: {
|
|
214
|
+
platformId: string;
|
|
215
|
+
name: string;
|
|
216
|
+
applicationId: string;
|
|
217
|
+
}): Promise<Models.PlatformAndroid>;
|
|
218
|
+
/**
|
|
219
|
+
* Update an Android platform by its unique ID. Use this endpoint to update the platform's name or application ID.
|
|
220
|
+
*
|
|
221
|
+
* @param {string} platformId - Platform ID.
|
|
222
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
223
|
+
* @param {string} applicationId - Android application ID. Max length: 256 chars.
|
|
224
|
+
* @throws {AppwriteException}
|
|
225
|
+
* @returns {Promise<Models.PlatformAndroid>}
|
|
226
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
227
|
+
*/
|
|
228
|
+
updateAndroidPlatform(platformId: string, name: string, applicationId: string): Promise<Models.PlatformAndroid>;
|
|
229
|
+
/**
|
|
230
|
+
* Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.
|
|
231
|
+
*
|
|
232
|
+
* @param {string} params.platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
233
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
234
|
+
* @param {string} params.bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
235
|
+
* @throws {AppwriteException}
|
|
236
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
237
|
+
*/
|
|
238
|
+
createApplePlatform(params: {
|
|
239
|
+
platformId: string;
|
|
240
|
+
name: string;
|
|
241
|
+
bundleIdentifier: string;
|
|
242
|
+
}): Promise<Models.PlatformApple>;
|
|
243
|
+
/**
|
|
244
|
+
* Create a new Apple platform for your project. Use this endpoint to register a new Apple platform where your users will run your application which will interact with the Appwrite API.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
247
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
248
|
+
* @param {string} bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
249
|
+
* @throws {AppwriteException}
|
|
250
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
251
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
252
|
+
*/
|
|
253
|
+
createApplePlatform(platformId: string, name: string, bundleIdentifier: string): Promise<Models.PlatformApple>;
|
|
254
|
+
/**
|
|
255
|
+
* Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.
|
|
256
|
+
*
|
|
257
|
+
* @param {string} params.platformId - Platform ID.
|
|
258
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
259
|
+
* @param {string} params.bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
260
|
+
* @throws {AppwriteException}
|
|
261
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
262
|
+
*/
|
|
263
|
+
updateApplePlatform(params: {
|
|
264
|
+
platformId: string;
|
|
265
|
+
name: string;
|
|
266
|
+
bundleIdentifier: string;
|
|
267
|
+
}): Promise<Models.PlatformApple>;
|
|
268
|
+
/**
|
|
269
|
+
* Update an Apple platform by its unique ID. Use this endpoint to update the platform's name or bundle identifier.
|
|
270
|
+
*
|
|
271
|
+
* @param {string} platformId - Platform ID.
|
|
272
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
273
|
+
* @param {string} bundleIdentifier - Apple bundle identifier. Max length: 256 chars.
|
|
274
|
+
* @throws {AppwriteException}
|
|
275
|
+
* @returns {Promise<Models.PlatformApple>}
|
|
276
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
277
|
+
*/
|
|
278
|
+
updateApplePlatform(platformId: string, name: string, bundleIdentifier: string): Promise<Models.PlatformApple>;
|
|
279
|
+
/**
|
|
280
|
+
* Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.
|
|
281
|
+
*
|
|
282
|
+
* @param {string} params.platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
283
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
284
|
+
* @param {string} params.packageName - Linux package name. Max length: 256 chars.
|
|
285
|
+
* @throws {AppwriteException}
|
|
286
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
287
|
+
*/
|
|
288
|
+
createLinuxPlatform(params: {
|
|
289
|
+
platformId: string;
|
|
290
|
+
name: string;
|
|
291
|
+
packageName: string;
|
|
292
|
+
}): Promise<Models.PlatformLinux>;
|
|
293
|
+
/**
|
|
294
|
+
* Create a new Linux platform for your project. Use this endpoint to register a new Linux platform where your users will run your application which will interact with the Appwrite API.
|
|
295
|
+
*
|
|
296
|
+
* @param {string} platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
297
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
298
|
+
* @param {string} packageName - Linux package name. Max length: 256 chars.
|
|
299
|
+
* @throws {AppwriteException}
|
|
300
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
301
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
302
|
+
*/
|
|
303
|
+
createLinuxPlatform(platformId: string, name: string, packageName: string): Promise<Models.PlatformLinux>;
|
|
304
|
+
/**
|
|
305
|
+
* Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.
|
|
306
|
+
*
|
|
307
|
+
* @param {string} params.platformId - Platform ID.
|
|
308
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
309
|
+
* @param {string} params.packageName - Linux package name. Max length: 256 chars.
|
|
310
|
+
* @throws {AppwriteException}
|
|
311
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
312
|
+
*/
|
|
313
|
+
updateLinuxPlatform(params: {
|
|
314
|
+
platformId: string;
|
|
315
|
+
name: string;
|
|
316
|
+
packageName: string;
|
|
317
|
+
}): Promise<Models.PlatformLinux>;
|
|
318
|
+
/**
|
|
319
|
+
* Update a Linux platform by its unique ID. Use this endpoint to update the platform's name or package name.
|
|
320
|
+
*
|
|
321
|
+
* @param {string} platformId - Platform ID.
|
|
322
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
323
|
+
* @param {string} packageName - Linux package name. Max length: 256 chars.
|
|
324
|
+
* @throws {AppwriteException}
|
|
325
|
+
* @returns {Promise<Models.PlatformLinux>}
|
|
326
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
327
|
+
*/
|
|
328
|
+
updateLinuxPlatform(platformId: string, name: string, packageName: string): Promise<Models.PlatformLinux>;
|
|
329
|
+
/**
|
|
330
|
+
* Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
331
|
+
*
|
|
332
|
+
* @param {string} params.platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
333
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
334
|
+
* @param {string} params.hostname - Platform web hostname. Max length: 256 chars.
|
|
335
|
+
* @throws {AppwriteException}
|
|
336
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
337
|
+
*/
|
|
338
|
+
createWebPlatform(params: {
|
|
339
|
+
platformId: string;
|
|
340
|
+
name: string;
|
|
341
|
+
hostname: string;
|
|
342
|
+
}): Promise<Models.PlatformWeb>;
|
|
343
|
+
/**
|
|
344
|
+
* Create a new web platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
|
345
|
+
*
|
|
346
|
+
* @param {string} platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
347
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
348
|
+
* @param {string} hostname - Platform web hostname. Max length: 256 chars.
|
|
349
|
+
* @throws {AppwriteException}
|
|
350
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
351
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
352
|
+
*/
|
|
353
|
+
createWebPlatform(platformId: string, name: string, hostname: string): Promise<Models.PlatformWeb>;
|
|
354
|
+
/**
|
|
355
|
+
* Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.
|
|
356
|
+
*
|
|
357
|
+
* @param {string} params.platformId - Platform ID.
|
|
358
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
359
|
+
* @param {string} params.hostname - Platform web hostname. Max length: 256 chars.
|
|
360
|
+
* @throws {AppwriteException}
|
|
361
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
362
|
+
*/
|
|
363
|
+
updateWebPlatform(params: {
|
|
364
|
+
platformId: string;
|
|
365
|
+
name: string;
|
|
366
|
+
hostname: string;
|
|
367
|
+
}): Promise<Models.PlatformWeb>;
|
|
368
|
+
/**
|
|
369
|
+
* Update a web platform by its unique ID. Use this endpoint to update the platform's name or hostname.
|
|
370
|
+
*
|
|
371
|
+
* @param {string} platformId - Platform ID.
|
|
372
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
373
|
+
* @param {string} hostname - Platform web hostname. Max length: 256 chars.
|
|
374
|
+
* @throws {AppwriteException}
|
|
375
|
+
* @returns {Promise<Models.PlatformWeb>}
|
|
376
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
377
|
+
*/
|
|
378
|
+
updateWebPlatform(platformId: string, name: string, hostname: string): Promise<Models.PlatformWeb>;
|
|
379
|
+
/**
|
|
380
|
+
* Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.
|
|
381
|
+
*
|
|
382
|
+
* @param {string} params.platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
383
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
384
|
+
* @param {string} params.packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
385
|
+
* @throws {AppwriteException}
|
|
386
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
387
|
+
*/
|
|
388
|
+
createWindowsPlatform(params: {
|
|
389
|
+
platformId: string;
|
|
390
|
+
name: string;
|
|
391
|
+
packageIdentifierName: string;
|
|
392
|
+
}): Promise<Models.PlatformWindows>;
|
|
393
|
+
/**
|
|
394
|
+
* Create a new Windows platform for your project. Use this endpoint to register a new Windows platform where your users will run your application which will interact with the Appwrite API.
|
|
395
|
+
*
|
|
396
|
+
* @param {string} platformId - Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
397
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
398
|
+
* @param {string} packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
399
|
+
* @throws {AppwriteException}
|
|
400
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
401
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
402
|
+
*/
|
|
403
|
+
createWindowsPlatform(platformId: string, name: string, packageIdentifierName: string): Promise<Models.PlatformWindows>;
|
|
404
|
+
/**
|
|
405
|
+
* Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.
|
|
406
|
+
*
|
|
407
|
+
* @param {string} params.platformId - Platform ID.
|
|
408
|
+
* @param {string} params.name - Platform name. Max length: 128 chars.
|
|
409
|
+
* @param {string} params.packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
410
|
+
* @throws {AppwriteException}
|
|
411
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
412
|
+
*/
|
|
413
|
+
updateWindowsPlatform(params: {
|
|
414
|
+
platformId: string;
|
|
415
|
+
name: string;
|
|
416
|
+
packageIdentifierName: string;
|
|
417
|
+
}): Promise<Models.PlatformWindows>;
|
|
418
|
+
/**
|
|
419
|
+
* Update a Windows platform by its unique ID. Use this endpoint to update the platform's name or package identifier name.
|
|
420
|
+
*
|
|
421
|
+
* @param {string} platformId - Platform ID.
|
|
422
|
+
* @param {string} name - Platform name. Max length: 128 chars.
|
|
423
|
+
* @param {string} packageIdentifierName - Windows package identifier name. Max length: 256 chars.
|
|
424
|
+
* @throws {AppwriteException}
|
|
425
|
+
* @returns {Promise<Models.PlatformWindows>}
|
|
426
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
427
|
+
*/
|
|
428
|
+
updateWindowsPlatform(platformId: string, name: string, packageIdentifierName: string): Promise<Models.PlatformWindows>;
|
|
429
|
+
/**
|
|
430
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
431
|
+
*
|
|
432
|
+
* @param {string} params.platformId - Platform ID.
|
|
433
|
+
* @throws {AppwriteException}
|
|
434
|
+
* @returns {Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>}
|
|
435
|
+
*/
|
|
436
|
+
getPlatform(params: {
|
|
437
|
+
platformId: string;
|
|
438
|
+
}): Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>;
|
|
439
|
+
/**
|
|
440
|
+
* Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
|
441
|
+
*
|
|
442
|
+
* @param {string} platformId - Platform ID.
|
|
443
|
+
* @throws {AppwriteException}
|
|
444
|
+
* @returns {Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>}
|
|
445
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
446
|
+
*/
|
|
447
|
+
getPlatform(platformId: string): Promise<Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux>;
|
|
448
|
+
/**
|
|
449
|
+
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
450
|
+
*
|
|
451
|
+
* @param {string} params.platformId - Platform ID.
|
|
452
|
+
* @throws {AppwriteException}
|
|
453
|
+
* @returns {Promise<{}>}
|
|
454
|
+
*/
|
|
455
|
+
deletePlatform(params: {
|
|
456
|
+
platformId: string;
|
|
457
|
+
}): Promise<{}>;
|
|
458
|
+
/**
|
|
459
|
+
* Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
|
460
|
+
*
|
|
461
|
+
* @param {string} platformId - Platform ID.
|
|
462
|
+
* @throws {AppwriteException}
|
|
463
|
+
* @returns {Promise<{}>}
|
|
464
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
465
|
+
*/
|
|
466
|
+
deletePlatform(platformId: string): Promise<{}>;
|
|
467
|
+
/**
|
|
468
|
+
* Update the status of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
469
|
+
*
|
|
470
|
+
* @param {ProtocolId} params.protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
471
|
+
* @param {boolean} params.enabled - Protocol status.
|
|
472
|
+
* @throws {AppwriteException}
|
|
473
|
+
* @returns {Promise<Models.Project>}
|
|
474
|
+
*/
|
|
475
|
+
updateProtocolStatus(params: {
|
|
476
|
+
protocolId: ProtocolId;
|
|
477
|
+
enabled: boolean;
|
|
478
|
+
}): Promise<Models.Project>;
|
|
479
|
+
/**
|
|
480
|
+
* Update the status of a specific protocol. Use this endpoint to enable or disable a protocol in your project.
|
|
481
|
+
*
|
|
482
|
+
* @param {ProtocolId} protocolId - Protocol name. Can be one of: rest, graphql, websocket
|
|
483
|
+
* @param {boolean} enabled - Protocol status.
|
|
484
|
+
* @throws {AppwriteException}
|
|
485
|
+
* @returns {Promise<Models.Project>}
|
|
486
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
487
|
+
*/
|
|
488
|
+
updateProtocolStatus(protocolId: ProtocolId, enabled: boolean): Promise<Models.Project>;
|
|
489
|
+
/**
|
|
490
|
+
* Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
491
|
+
*
|
|
492
|
+
* @param {ServiceId} params.serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging
|
|
493
|
+
* @param {boolean} params.enabled - Service status.
|
|
494
|
+
* @throws {AppwriteException}
|
|
495
|
+
* @returns {Promise<Models.Project>}
|
|
496
|
+
*/
|
|
497
|
+
updateServiceStatus(params: {
|
|
498
|
+
serviceId: ServiceId;
|
|
499
|
+
enabled: boolean;
|
|
500
|
+
}): Promise<Models.Project>;
|
|
501
|
+
/**
|
|
502
|
+
* Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
|
|
503
|
+
*
|
|
504
|
+
* @param {ServiceId} serviceId - Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging
|
|
505
|
+
* @param {boolean} enabled - Service status.
|
|
506
|
+
* @throws {AppwriteException}
|
|
507
|
+
* @returns {Promise<Models.Project>}
|
|
508
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
509
|
+
*/
|
|
510
|
+
updateServiceStatus(serviceId: ServiceId, enabled: boolean): Promise<Models.Project>;
|
|
18
511
|
/**
|
|
19
512
|
* Get a list of all project environment variables.
|
|
20
513
|
*
|