@appwrite.io/console 7.0.0 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +1 -1
- package/CHANGELOG.md +30 -6
- package/README.md +2 -2
- package/dist/cjs/sdk.js +222 -303
- package/docs/examples/databases/create-index.md +2 -2
- package/docs/examples/domains/create-purchase.md +2 -1
- package/docs/examples/domains/create-transfer-in.md +2 -1
- package/docs/examples/domains/update-auto-renewal.md +16 -0
- package/docs/examples/project/create-variable.md +1 -0
- package/docs/examples/project/list-variables.md +4 -1
- package/docs/examples/project/update-variable.md +1 -1
- package/docs/examples/tablesdb/create-index.md +2 -2
- package/docs/examples/users/update-impersonator.md +16 -0
- package/package.json +7 -7
- package/rollup.config.js +2 -1
- package/src/client.ts +61 -1
- package/src/enums/appwrite-migration-resource.ts +2 -0
- package/src/enums/backup-services.ts +3 -0
- package/src/enums/build-runtime.ts +0 -86
- package/src/enums/database-type.ts +2 -0
- package/src/enums/databases-index-type.ts +6 -0
- package/src/enums/runtime.ts +0 -86
- package/src/enums/runtimes.ts +0 -86
- package/src/enums/scopes.ts +13 -2
- package/src/enums/{index-type.ts → tables-db-index-type.ts} +1 -1
- package/src/enums/template-reference-type.ts +1 -1
- package/src/enums/use-cases.ts +7 -2
- package/src/index.ts +2 -1
- package/src/models.ts +172 -4
- package/src/services/databases.ts +10 -10
- package/src/services/domains.ts +103 -26
- package/src/services/project.ts +76 -33
- package/src/services/tables-db.ts +10 -10
- package/src/services/users.ts +67 -2
- package/src/services/vcs.ts +10 -10
- package/dist/cjs/sdk.js.map +0 -1
- package/dist/esm/sdk.js +0 -29782
- package/dist/esm/sdk.js.map +0 -1
- package/dist/iife/sdk.js +0 -33583
- package/types/channel.d.ts +0 -74
- package/types/client.d.ts +0 -260
- package/types/enums/adapter.d.ts +0 -4
- package/types/enums/api-service.d.ts +0 -15
- package/types/enums/api.d.ts +0 -5
- package/types/enums/appwrite-migration-resource.d.ts +0 -25
- package/types/enums/attribute-status.d.ts +0 -7
- package/types/enums/auth-method.d.ts +0 -9
- package/types/enums/authentication-factor.d.ts +0 -6
- package/types/enums/authenticator-type.d.ts +0 -3
- package/types/enums/backup-services.d.ts +0 -5
- package/types/enums/billing-plan-group.d.ts +0 -5
- package/types/enums/browser-permission.d.ts +0 -22
- package/types/enums/browser.d.ts +0 -16
- package/types/enums/build-runtime.d.ts +0 -174
- package/types/enums/column-status.d.ts +0 -7
- package/types/enums/compression.d.ts +0 -5
- package/types/enums/console-resource-type.d.ts +0 -3
- package/types/enums/credit-card.d.ts +0 -19
- package/types/enums/database-type.d.ts +0 -4
- package/types/enums/deployment-download-type.d.ts +0 -4
- package/types/enums/deployment-status.d.ts +0 -8
- package/types/enums/domain-purchase-status.d.ts +0 -6
- package/types/enums/domain-transfer-status-enum.d.ts +0 -10
- package/types/enums/email-template-locale.d.ts +0 -133
- package/types/enums/email-template-type.d.ts +0 -9
- package/types/enums/execution-method.d.ts +0 -9
- package/types/enums/execution-status.d.ts +0 -7
- package/types/enums/execution-trigger.d.ts +0 -5
- package/types/enums/filter-type.d.ts +0 -4
- package/types/enums/firebase-migration-resource.d.ts +0 -12
- package/types/enums/flag.d.ts +0 -197
- package/types/enums/framework.d.ts +0 -17
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/health-antivirus-status.d.ts +0 -5
- package/types/enums/health-check-status.d.ts +0 -4
- package/types/enums/image-format.d.ts +0 -9
- package/types/enums/image-gravity.d.ts +0 -11
- package/types/enums/index-status.d.ts +0 -7
- package/types/enums/index-type.d.ts +0 -6
- package/types/enums/message-priority.d.ts +0 -4
- package/types/enums/message-status.d.ts +0 -7
- package/types/enums/messaging-provider-type.d.ts +0 -5
- package/types/enums/n-host-migration-resource.d.ts +0 -13
- package/types/enums/name.d.ts +0 -15
- package/types/enums/o-auth-provider.d.ts +0 -41
- package/types/enums/order-by.d.ts +0 -4
- package/types/enums/password-hash.d.ts +0 -13
- package/types/enums/platform-type.d.ts +0 -17
- package/types/enums/platform.d.ts +0 -4
- package/types/enums/project-usage-range.d.ts +0 -4
- package/types/enums/proxy-resource-type.d.ts +0 -4
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +0 -4
- package/types/enums/proxy-rule-status.d.ts +0 -6
- package/types/enums/region.d.ts +0 -8
- package/types/enums/registration-type.d.ts +0 -6
- package/types/enums/relation-mutate.d.ts +0 -5
- package/types/enums/relationship-type.d.ts +0 -6
- package/types/enums/resource-type.d.ts +0 -6
- package/types/enums/runtime.d.ts +0 -174
- package/types/enums/runtimes.d.ts +0 -174
- package/types/enums/scopes.d.ts +0 -70
- package/types/enums/sms-template-locale.d.ts +0 -133
- package/types/enums/sms-template-type.d.ts +0 -6
- package/types/enums/smtp-encryption.d.ts +0 -5
- package/types/enums/smtp-secure.d.ts +0 -4
- package/types/enums/status-code.d.ts +0 -6
- package/types/enums/status.d.ts +0 -3
- package/types/enums/supabase-migration-resource.d.ts +0 -13
- package/types/enums/template-reference-type.d.ts +0 -5
- package/types/enums/theme.d.ts +0 -4
- package/types/enums/timezone.d.ts +0 -421
- package/types/enums/usage-range.d.ts +0 -5
- package/types/enums/use-cases.d.ts +0 -11
- package/types/enums/vcs-detection-type.d.ts +0 -4
- package/types/enums/vcs-reference-type.d.ts +0 -5
- package/types/id.d.ts +0 -20
- package/types/index.d.ts +0 -117
- package/types/models.d.ts +0 -9071
- package/types/operator.d.ts +0 -180
- package/types/permission.d.ts +0 -43
- package/types/query.d.ts +0 -442
- package/types/role.d.ts +0 -70
- package/types/service.d.ts +0 -11
- package/types/services/account.d.ts +0 -1536
- package/types/services/activities.d.ts +0 -46
- package/types/services/assistant.d.ts +0 -24
- package/types/services/avatars.d.ts +0 -320
- package/types/services/backups.d.ts +0 -277
- package/types/services/console.d.ts +0 -248
- package/types/services/databases.d.ts +0 -2435
- package/types/services/domains.d.ts +0 -1499
- package/types/services/functions.d.ts +0 -842
- package/types/services/graphql.d.ts +0 -43
- package/types/services/health.d.ts +0 -475
- package/types/services/locale.d.ts +0 -64
- package/types/services/messaging.d.ts +0 -1989
- package/types/services/migrations.d.ts +0 -417
- package/types/services/organizations.d.ts +0 -1009
- package/types/services/project.d.ts +0 -130
- package/types/services/projects.d.ts +0 -1626
- package/types/services/proxy.d.ts +0 -190
- package/types/services/realtime.d.ts +0 -134
- package/types/services/sites.d.ts +0 -800
- package/types/services/storage.d.ts +0 -467
- package/types/services/tables-db.d.ts +0 -2352
- package/types/services/teams.d.ts +0 -366
- package/types/services/tokens.d.ts +0 -119
- package/types/services/users.d.ts +0 -1184
- package/types/services/vcs.d.ts +0 -252
- package/types/services/webhooks.d.ts +0 -165
|
@@ -1,130 +0,0 @@
|
|
|
1
|
-
import { Client } from '../client';
|
|
2
|
-
import type { Models } from '../models';
|
|
3
|
-
import { ProjectUsageRange } from '../enums/project-usage-range';
|
|
4
|
-
export declare class Project {
|
|
5
|
-
client: Client;
|
|
6
|
-
constructor(client: Client);
|
|
7
|
-
/**
|
|
8
|
-
* Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
|
|
9
|
-
*
|
|
10
|
-
* @param {string} params.startDate - Starting date for the usage
|
|
11
|
-
* @param {string} params.endDate - End date for the usage
|
|
12
|
-
* @param {ProjectUsageRange} params.period - Period used
|
|
13
|
-
* @throws {AppwriteException}
|
|
14
|
-
* @returns {Promise<Models.UsageProject>}
|
|
15
|
-
*/
|
|
16
|
-
getUsage(params: {
|
|
17
|
-
startDate: string;
|
|
18
|
-
endDate: string;
|
|
19
|
-
period?: ProjectUsageRange;
|
|
20
|
-
}): Promise<Models.UsageProject>;
|
|
21
|
-
/**
|
|
22
|
-
* Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
|
|
23
|
-
*
|
|
24
|
-
* @param {string} startDate - Starting date for the usage
|
|
25
|
-
* @param {string} endDate - End date for the usage
|
|
26
|
-
* @param {ProjectUsageRange} period - Period used
|
|
27
|
-
* @throws {AppwriteException}
|
|
28
|
-
* @returns {Promise<Models.UsageProject>}
|
|
29
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
30
|
-
*/
|
|
31
|
-
getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
|
|
32
|
-
/**
|
|
33
|
-
* Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.
|
|
34
|
-
*
|
|
35
|
-
* @throws {AppwriteException}
|
|
36
|
-
* @returns {Promise<Models.VariableList>}
|
|
37
|
-
*/
|
|
38
|
-
listVariables(): Promise<Models.VariableList>;
|
|
39
|
-
/**
|
|
40
|
-
* Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.
|
|
41
|
-
*
|
|
42
|
-
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
43
|
-
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
44
|
-
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
45
|
-
* @throws {AppwriteException}
|
|
46
|
-
* @returns {Promise<Models.Variable>}
|
|
47
|
-
*/
|
|
48
|
-
createVariable(params: {
|
|
49
|
-
key: string;
|
|
50
|
-
value: string;
|
|
51
|
-
secret?: boolean;
|
|
52
|
-
}): Promise<Models.Variable>;
|
|
53
|
-
/**
|
|
54
|
-
* Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.
|
|
55
|
-
*
|
|
56
|
-
* @param {string} key - Variable key. Max length: 255 chars.
|
|
57
|
-
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
58
|
-
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
59
|
-
* @throws {AppwriteException}
|
|
60
|
-
* @returns {Promise<Models.Variable>}
|
|
61
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
62
|
-
*/
|
|
63
|
-
createVariable(key: string, value: string, secret?: boolean): Promise<Models.Variable>;
|
|
64
|
-
/**
|
|
65
|
-
* Get a project variable by its unique ID.
|
|
66
|
-
*
|
|
67
|
-
* @param {string} params.variableId - Variable unique ID.
|
|
68
|
-
* @throws {AppwriteException}
|
|
69
|
-
* @returns {Promise<Models.Variable>}
|
|
70
|
-
*/
|
|
71
|
-
getVariable(params: {
|
|
72
|
-
variableId: string;
|
|
73
|
-
}): Promise<Models.Variable>;
|
|
74
|
-
/**
|
|
75
|
-
* Get a project variable by its unique ID.
|
|
76
|
-
*
|
|
77
|
-
* @param {string} variableId - Variable unique ID.
|
|
78
|
-
* @throws {AppwriteException}
|
|
79
|
-
* @returns {Promise<Models.Variable>}
|
|
80
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
81
|
-
*/
|
|
82
|
-
getVariable(variableId: string): Promise<Models.Variable>;
|
|
83
|
-
/**
|
|
84
|
-
* Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.
|
|
85
|
-
*
|
|
86
|
-
* @param {string} params.variableId - Variable unique ID.
|
|
87
|
-
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
88
|
-
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
89
|
-
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
90
|
-
* @throws {AppwriteException}
|
|
91
|
-
* @returns {Promise<Models.Variable>}
|
|
92
|
-
*/
|
|
93
|
-
updateVariable(params: {
|
|
94
|
-
variableId: string;
|
|
95
|
-
key: string;
|
|
96
|
-
value?: string;
|
|
97
|
-
secret?: boolean;
|
|
98
|
-
}): Promise<Models.Variable>;
|
|
99
|
-
/**
|
|
100
|
-
* Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.
|
|
101
|
-
*
|
|
102
|
-
* @param {string} variableId - Variable unique ID.
|
|
103
|
-
* @param {string} key - Variable key. Max length: 255 chars.
|
|
104
|
-
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
105
|
-
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
106
|
-
* @throws {AppwriteException}
|
|
107
|
-
* @returns {Promise<Models.Variable>}
|
|
108
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
109
|
-
*/
|
|
110
|
-
updateVariable(variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
|
|
111
|
-
/**
|
|
112
|
-
* Delete a project variable by its unique ID.
|
|
113
|
-
*
|
|
114
|
-
* @param {string} params.variableId - Variable unique ID.
|
|
115
|
-
* @throws {AppwriteException}
|
|
116
|
-
* @returns {Promise<{}>}
|
|
117
|
-
*/
|
|
118
|
-
deleteVariable(params: {
|
|
119
|
-
variableId: string;
|
|
120
|
-
}): Promise<{}>;
|
|
121
|
-
/**
|
|
122
|
-
* Delete a project variable by its unique ID.
|
|
123
|
-
*
|
|
124
|
-
* @param {string} variableId - Variable unique ID.
|
|
125
|
-
* @throws {AppwriteException}
|
|
126
|
-
* @returns {Promise<{}>}
|
|
127
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
128
|
-
*/
|
|
129
|
-
deleteVariable(variableId: string): Promise<{}>;
|
|
130
|
-
}
|