@appwrite.io/console 8.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 +8 -0
- package/README.md +1 -1
- package/dist/cjs/sdk.js +12 -1
- package/package.json +1 -1
- package/src/client.ts +13 -1
- package/src/models.ts +122 -0
- package/src/services/vcs.ts +10 -10
- package/dist/cjs/sdk.js.map +0 -1
- package/dist/esm/sdk.js +0 -29694
- package/dist/esm/sdk.js.map +0 -1
- package/dist/iife/sdk.js +0 -33504
- package/types/channel.d.ts +0 -74
- package/types/client.d.ts +0 -293
- 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 -27
- 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 -8
- 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 -88
- 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 -6
- package/types/enums/databases-index-type.d.ts +0 -6
- 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/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 -88
- package/types/enums/runtimes.d.ts +0 -88
- package/types/enums/scopes.d.ts +0 -81
- 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/tables-db-index-type.d.ts +0 -6
- 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 -16
- 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 -118
- package/types/models.d.ts +0 -9120
- 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 -1527
- 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 -148
- 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 -1208
- package/types/services/vcs.d.ts +0 -252
- package/types/services/webhooks.d.ts +0 -165
|
@@ -1,148 +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 environment variables.
|
|
34
|
-
*
|
|
35
|
-
* @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: key, resourceType, resourceId, secret
|
|
36
|
-
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
37
|
-
* @throws {AppwriteException}
|
|
38
|
-
* @returns {Promise<Models.VariableList>}
|
|
39
|
-
*/
|
|
40
|
-
listVariables(params?: {
|
|
41
|
-
queries?: string[];
|
|
42
|
-
total?: boolean;
|
|
43
|
-
}): Promise<Models.VariableList>;
|
|
44
|
-
/**
|
|
45
|
-
* Get a list of all project environment variables.
|
|
46
|
-
*
|
|
47
|
-
* @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: key, resourceType, resourceId, secret
|
|
48
|
-
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
49
|
-
* @throws {AppwriteException}
|
|
50
|
-
* @returns {Promise<Models.VariableList>}
|
|
51
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
52
|
-
*/
|
|
53
|
-
listVariables(queries?: string[], total?: boolean): Promise<Models.VariableList>;
|
|
54
|
-
/**
|
|
55
|
-
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
56
|
-
*
|
|
57
|
-
* @param {string} params.variableId - Variable 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.
|
|
58
|
-
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
59
|
-
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
60
|
-
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
61
|
-
* @throws {AppwriteException}
|
|
62
|
-
* @returns {Promise<Models.Variable>}
|
|
63
|
-
*/
|
|
64
|
-
createVariable(params: {
|
|
65
|
-
variableId: string;
|
|
66
|
-
key: string;
|
|
67
|
-
value: string;
|
|
68
|
-
secret?: boolean;
|
|
69
|
-
}): Promise<Models.Variable>;
|
|
70
|
-
/**
|
|
71
|
-
* Create a new project environment variable. These variables can be accessed by all functions and sites in the project.
|
|
72
|
-
*
|
|
73
|
-
* @param {string} variableId - Variable 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.
|
|
74
|
-
* @param {string} key - Variable key. Max length: 255 chars.
|
|
75
|
-
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
76
|
-
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
77
|
-
* @throws {AppwriteException}
|
|
78
|
-
* @returns {Promise<Models.Variable>}
|
|
79
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
80
|
-
*/
|
|
81
|
-
createVariable(variableId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
|
|
82
|
-
/**
|
|
83
|
-
* Get a variable by its unique ID.
|
|
84
|
-
*
|
|
85
|
-
* @param {string} params.variableId - Variable ID.
|
|
86
|
-
* @throws {AppwriteException}
|
|
87
|
-
* @returns {Promise<Models.Variable>}
|
|
88
|
-
*/
|
|
89
|
-
getVariable(params: {
|
|
90
|
-
variableId: string;
|
|
91
|
-
}): Promise<Models.Variable>;
|
|
92
|
-
/**
|
|
93
|
-
* Get a variable by its unique ID.
|
|
94
|
-
*
|
|
95
|
-
* @param {string} variableId - Variable ID.
|
|
96
|
-
* @throws {AppwriteException}
|
|
97
|
-
* @returns {Promise<Models.Variable>}
|
|
98
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
99
|
-
*/
|
|
100
|
-
getVariable(variableId: string): Promise<Models.Variable>;
|
|
101
|
-
/**
|
|
102
|
-
* Update variable by its unique ID.
|
|
103
|
-
*
|
|
104
|
-
* @param {string} params.variableId - Variable ID.
|
|
105
|
-
* @param {string} params.key - Variable key. Max length: 255 chars.
|
|
106
|
-
* @param {string} params.value - Variable value. Max length: 8192 chars.
|
|
107
|
-
* @param {boolean} params.secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
108
|
-
* @throws {AppwriteException}
|
|
109
|
-
* @returns {Promise<Models.Variable>}
|
|
110
|
-
*/
|
|
111
|
-
updateVariable(params: {
|
|
112
|
-
variableId: string;
|
|
113
|
-
key?: string;
|
|
114
|
-
value?: string;
|
|
115
|
-
secret?: boolean;
|
|
116
|
-
}): Promise<Models.Variable>;
|
|
117
|
-
/**
|
|
118
|
-
* Update variable by its unique ID.
|
|
119
|
-
*
|
|
120
|
-
* @param {string} variableId - Variable ID.
|
|
121
|
-
* @param {string} key - Variable key. Max length: 255 chars.
|
|
122
|
-
* @param {string} value - Variable value. Max length: 8192 chars.
|
|
123
|
-
* @param {boolean} secret - Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
124
|
-
* @throws {AppwriteException}
|
|
125
|
-
* @returns {Promise<Models.Variable>}
|
|
126
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
127
|
-
*/
|
|
128
|
-
updateVariable(variableId: string, key?: string, value?: string, secret?: boolean): Promise<Models.Variable>;
|
|
129
|
-
/**
|
|
130
|
-
* Delete a variable by its unique ID.
|
|
131
|
-
*
|
|
132
|
-
* @param {string} params.variableId - Variable ID.
|
|
133
|
-
* @throws {AppwriteException}
|
|
134
|
-
* @returns {Promise<{}>}
|
|
135
|
-
*/
|
|
136
|
-
deleteVariable(params: {
|
|
137
|
-
variableId: string;
|
|
138
|
-
}): Promise<{}>;
|
|
139
|
-
/**
|
|
140
|
-
* Delete a variable by its unique ID.
|
|
141
|
-
*
|
|
142
|
-
* @param {string} variableId - Variable ID.
|
|
143
|
-
* @throws {AppwriteException}
|
|
144
|
-
* @returns {Promise<{}>}
|
|
145
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
146
|
-
*/
|
|
147
|
-
deleteVariable(variableId: string): Promise<{}>;
|
|
148
|
-
}
|