appbuild-oceanbase-console 1.12.2 → 1.13.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/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +3837 -1017
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +3831 -1018
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +10131 -3554
- package/package.json +7 -2
- package/types/channel.d.ts +74 -0
- package/types/client.d.ts +84 -16
- package/types/enums/appwrite-migration-resource.d.ts +25 -0
- package/types/enums/backup-services.d.ts +5 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/domain-purchase-status.d.ts +6 -0
- package/types/enums/domain-transfer-status-enum.d.ts +10 -0
- package/types/enums/filter-type.d.ts +4 -0
- package/types/enums/firebase-migration-resource.d.ts +12 -0
- package/types/enums/frameworks.d.ts +17 -0
- package/types/enums/n-host-migration-resource.d.ts +13 -0
- package/types/enums/order-by.d.ts +4 -0
- package/types/enums/registration-type.d.ts +6 -0
- package/types/enums/resource-type.d.ts +6 -0
- package/types/enums/runtimes.d.ts +180 -0
- package/types/enums/scopes.d.ts +70 -0
- package/types/enums/supabase-migration-resource.d.ts +13 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/use-cases.d.ts +11 -0
- package/types/enums/vcs-reference-type.d.ts +5 -0
- package/types/index.d.ts +119 -96
- package/types/migrations.d.ts +10 -9
- package/types/models.d.ts +1270 -136
- package/types/query.d.ts +60 -8
- package/types/services/account.d.ts +162 -39
- package/types/services/activities.d.ts +46 -0
- package/types/services/avatars.d.ts +9 -8
- package/types/services/backups.d.ts +13 -12
- package/types/services/console.d.ts +41 -3
- package/types/services/databases.d.ts +384 -68
- package/types/services/domains.d.ts +223 -0
- package/types/services/functions.d.ts +46 -31
- package/types/services/health.d.ts +49 -6
- package/types/services/messaging.d.ts +2 -2
- package/types/services/organizations.d.ts +203 -36
- package/types/services/projects.d.ts +151 -210
- package/types/services/realtime.d.ts +26 -10
- package/types/services/sites.d.ts +49 -29
- package/types/services/storage.d.ts +12 -12
- package/types/services/tables-db.d.ts +352 -34
- package/types/services/teams.d.ts +4 -4
- package/types/services/users.d.ts +26 -2
- package/types/services/vcs.d.ts +4 -1
- package/types/services/webhooks.d.ts +165 -0
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
+
import { RegistrationType } from '../enums/registration-type';
|
|
4
|
+
import { FilterType } from '../enums/filter-type';
|
|
3
5
|
export declare class Domains {
|
|
4
6
|
client: Client;
|
|
5
7
|
constructor(client: Client);
|
|
@@ -47,6 +49,208 @@ export declare class Domains {
|
|
|
47
49
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
48
50
|
*/
|
|
49
51
|
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
52
|
+
/**
|
|
53
|
+
* Get the registration price for a domain name.
|
|
54
|
+
*
|
|
55
|
+
* @param {string} params.domain - Domain name to get price for.
|
|
56
|
+
* @param {number} params.periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
57
|
+
* @param {RegistrationType} params.registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
58
|
+
* @throws {AppwriteException}
|
|
59
|
+
* @returns {Promise<Models.DomainPrice>}
|
|
60
|
+
*/
|
|
61
|
+
getPrice(params: {
|
|
62
|
+
domain: string;
|
|
63
|
+
periodYears?: number;
|
|
64
|
+
registrationType?: RegistrationType;
|
|
65
|
+
}): Promise<Models.DomainPrice>;
|
|
66
|
+
/**
|
|
67
|
+
* Get the registration price for a domain name.
|
|
68
|
+
*
|
|
69
|
+
* @param {string} domain - Domain name to get price for.
|
|
70
|
+
* @param {number} periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
71
|
+
* @param {RegistrationType} registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
72
|
+
* @throws {AppwriteException}
|
|
73
|
+
* @returns {Promise<Models.DomainPrice>}
|
|
74
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
75
|
+
*/
|
|
76
|
+
getPrice(domain: string, periodYears?: number, registrationType?: RegistrationType): Promise<Models.DomainPrice>;
|
|
77
|
+
/**
|
|
78
|
+
* Create a domain purchase with registrant information.
|
|
79
|
+
*
|
|
80
|
+
* @param {string} params.domain - Fully qualified domain name to purchase (for example, example.com).
|
|
81
|
+
* @param {string} params.organizationId - Team ID that will own the domain.
|
|
82
|
+
* @param {string} params.firstName - Registrant first name used for domain registration.
|
|
83
|
+
* @param {string} params.lastName - Registrant last name used for domain registration.
|
|
84
|
+
* @param {string} params.email - Registrant email address for registration and notices.
|
|
85
|
+
* @param {string} params.phone - Registrant phone number in E.164 format (for example, +15555551234).
|
|
86
|
+
* @param {string} params.billingAddressId - Billing address ID used for registration contact details.
|
|
87
|
+
* @param {string} params.paymentMethodId - Payment method ID to authorize and capture the purchase.
|
|
88
|
+
* @param {string} params.addressLine3 - Additional address line for the registrant (line 3).
|
|
89
|
+
* @param {string} params.companyName - Company or organization name for the registrant.
|
|
90
|
+
* @param {number} params.periodYears - Registration term in years (1-10).
|
|
91
|
+
* @throws {AppwriteException}
|
|
92
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
93
|
+
*/
|
|
94
|
+
createPurchase(params: {
|
|
95
|
+
domain: string;
|
|
96
|
+
organizationId: string;
|
|
97
|
+
firstName: string;
|
|
98
|
+
lastName: string;
|
|
99
|
+
email: string;
|
|
100
|
+
phone: string;
|
|
101
|
+
billingAddressId: string;
|
|
102
|
+
paymentMethodId: string;
|
|
103
|
+
addressLine3?: string;
|
|
104
|
+
companyName?: string;
|
|
105
|
+
periodYears?: number;
|
|
106
|
+
}): Promise<Models.DomainPurchase>;
|
|
107
|
+
/**
|
|
108
|
+
* Create a domain purchase with registrant information.
|
|
109
|
+
*
|
|
110
|
+
* @param {string} domain - Fully qualified domain name to purchase (for example, example.com).
|
|
111
|
+
* @param {string} organizationId - Team ID that will own the domain.
|
|
112
|
+
* @param {string} firstName - Registrant first name used for domain registration.
|
|
113
|
+
* @param {string} lastName - Registrant last name used for domain registration.
|
|
114
|
+
* @param {string} email - Registrant email address for registration and notices.
|
|
115
|
+
* @param {string} phone - Registrant phone number in E.164 format (for example, +15555551234).
|
|
116
|
+
* @param {string} billingAddressId - Billing address ID used for registration contact details.
|
|
117
|
+
* @param {string} paymentMethodId - Payment method ID to authorize and capture the purchase.
|
|
118
|
+
* @param {string} addressLine3 - Additional address line for the registrant (line 3).
|
|
119
|
+
* @param {string} companyName - Company or organization name for the registrant.
|
|
120
|
+
* @param {number} periodYears - Registration term in years (1-10).
|
|
121
|
+
* @throws {AppwriteException}
|
|
122
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
123
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
124
|
+
*/
|
|
125
|
+
createPurchase(domain: string, organizationId: string, firstName: string, lastName: string, email: string, phone: string, billingAddressId: string, paymentMethodId: string, addressLine3?: string, companyName?: string, periodYears?: number): Promise<Models.DomainPurchase>;
|
|
126
|
+
/**
|
|
127
|
+
* Confirm and complete a domain purchase after payment authentication.
|
|
128
|
+
*
|
|
129
|
+
* @param {string} params.domainId - Domain ID to confirm purchase for.
|
|
130
|
+
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
131
|
+
* @throws {AppwriteException}
|
|
132
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
133
|
+
*/
|
|
134
|
+
updatePurchase(params: {
|
|
135
|
+
domainId: string;
|
|
136
|
+
organizationId: string;
|
|
137
|
+
}): Promise<Models.DomainPurchase>;
|
|
138
|
+
/**
|
|
139
|
+
* Confirm and complete a domain purchase after payment authentication.
|
|
140
|
+
*
|
|
141
|
+
* @param {string} domainId - Domain ID to confirm purchase for.
|
|
142
|
+
* @param {string} organizationId - Team ID that owns the domain.
|
|
143
|
+
* @throws {AppwriteException}
|
|
144
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
145
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
146
|
+
*/
|
|
147
|
+
updatePurchase(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
148
|
+
/**
|
|
149
|
+
* List domain suggestions.
|
|
150
|
+
*
|
|
151
|
+
* @param {string} params.query - Query to find available domains and suggestions. Max length: 256 chars.
|
|
152
|
+
* @param {string[]} params.tlds - TLDs to suggest.
|
|
153
|
+
* @param {number} params.limit - Maximum number of suggestions to return.
|
|
154
|
+
* @param {FilterType} params.filterType - Filter type: premium, suggestion.
|
|
155
|
+
* @param {number} params.priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
|
|
156
|
+
* @param {number} params.priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
|
|
157
|
+
* @throws {AppwriteException}
|
|
158
|
+
* @returns {Promise<Models.DomainSuggestionsList>}
|
|
159
|
+
*/
|
|
160
|
+
listSuggestions(params: {
|
|
161
|
+
query: string;
|
|
162
|
+
tlds?: string[];
|
|
163
|
+
limit?: number;
|
|
164
|
+
filterType?: FilterType;
|
|
165
|
+
priceMax?: number;
|
|
166
|
+
priceMin?: number;
|
|
167
|
+
}): Promise<Models.DomainSuggestionsList>;
|
|
168
|
+
/**
|
|
169
|
+
* List domain suggestions.
|
|
170
|
+
*
|
|
171
|
+
* @param {string} query - Query to find available domains and suggestions. Max length: 256 chars.
|
|
172
|
+
* @param {string[]} tlds - TLDs to suggest.
|
|
173
|
+
* @param {number} limit - Maximum number of suggestions to return.
|
|
174
|
+
* @param {FilterType} filterType - Filter type: premium, suggestion.
|
|
175
|
+
* @param {number} priceMax - Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.
|
|
176
|
+
* @param {number} priceMin - Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.
|
|
177
|
+
* @throws {AppwriteException}
|
|
178
|
+
* @returns {Promise<Models.DomainSuggestionsList>}
|
|
179
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
180
|
+
*/
|
|
181
|
+
listSuggestions(query: string, tlds?: string[], limit?: number, filterType?: FilterType, priceMax?: number, priceMin?: number): Promise<Models.DomainSuggestionsList>;
|
|
182
|
+
/**
|
|
183
|
+
* Create a domain transfer in with authorization code and registrant information.
|
|
184
|
+
*
|
|
185
|
+
* @param {string} params.domain - Domain name to transfer in.
|
|
186
|
+
* @param {string} params.organizationId - Organization ID that this domain will belong to.
|
|
187
|
+
* @param {string} params.authCode - Authorization code for the domain transfer.
|
|
188
|
+
* @param {string} params.paymentMethodId - Payment method ID to authorize and capture the transfer.
|
|
189
|
+
* @throws {AppwriteException}
|
|
190
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
191
|
+
*/
|
|
192
|
+
createTransferIn(params: {
|
|
193
|
+
domain: string;
|
|
194
|
+
organizationId: string;
|
|
195
|
+
authCode: string;
|
|
196
|
+
paymentMethodId: string;
|
|
197
|
+
}): Promise<Models.DomainPurchase>;
|
|
198
|
+
/**
|
|
199
|
+
* Create a domain transfer in with authorization code and registrant information.
|
|
200
|
+
*
|
|
201
|
+
* @param {string} domain - Domain name to transfer in.
|
|
202
|
+
* @param {string} organizationId - Organization ID that this domain will belong to.
|
|
203
|
+
* @param {string} authCode - Authorization code for the domain transfer.
|
|
204
|
+
* @param {string} paymentMethodId - Payment method ID to authorize and capture the transfer.
|
|
205
|
+
* @throws {AppwriteException}
|
|
206
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
207
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
208
|
+
*/
|
|
209
|
+
createTransferIn(domain: string, organizationId: string, authCode: string, paymentMethodId: string): Promise<Models.DomainPurchase>;
|
|
210
|
+
/**
|
|
211
|
+
* Confirm and complete a domain transfer in after payment authentication.
|
|
212
|
+
*
|
|
213
|
+
* @param {string} params.domainId - Domain ID to confirm transfer for.
|
|
214
|
+
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
215
|
+
* @throws {AppwriteException}
|
|
216
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
217
|
+
*/
|
|
218
|
+
updateTransferIn(params: {
|
|
219
|
+
domainId: string;
|
|
220
|
+
organizationId: string;
|
|
221
|
+
}): Promise<Models.DomainPurchase>;
|
|
222
|
+
/**
|
|
223
|
+
* Confirm and complete a domain transfer in after payment authentication.
|
|
224
|
+
*
|
|
225
|
+
* @param {string} domainId - Domain ID to confirm transfer for.
|
|
226
|
+
* @param {string} organizationId - Team ID that owns the domain.
|
|
227
|
+
* @throws {AppwriteException}
|
|
228
|
+
* @returns {Promise<Models.DomainPurchase>}
|
|
229
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
230
|
+
*/
|
|
231
|
+
updateTransferIn(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
232
|
+
/**
|
|
233
|
+
* Create a domain transfer out and return the authorization code.
|
|
234
|
+
*
|
|
235
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
236
|
+
* @param {string} params.organizationId - Organization ID that this domain belongs to.
|
|
237
|
+
* @throws {AppwriteException}
|
|
238
|
+
* @returns {Promise<Models.DomainTransferOut>}
|
|
239
|
+
*/
|
|
240
|
+
createTransferOut(params: {
|
|
241
|
+
domainId: string;
|
|
242
|
+
organizationId: string;
|
|
243
|
+
}): Promise<Models.DomainTransferOut>;
|
|
244
|
+
/**
|
|
245
|
+
* Create a domain transfer out and return the authorization code.
|
|
246
|
+
*
|
|
247
|
+
* @param {string} domainId - Domain unique ID.
|
|
248
|
+
* @param {string} organizationId - Organization ID that this domain belongs to.
|
|
249
|
+
* @throws {AppwriteException}
|
|
250
|
+
* @returns {Promise<Models.DomainTransferOut>}
|
|
251
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
252
|
+
*/
|
|
253
|
+
createTransferOut(domainId: string, organizationId: string): Promise<Models.DomainTransferOut>;
|
|
50
254
|
/**
|
|
51
255
|
* Get a domain by its unique ID.
|
|
52
256
|
*
|
|
@@ -1228,6 +1432,25 @@ export declare class Domains {
|
|
|
1228
1432
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1229
1433
|
*/
|
|
1230
1434
|
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Get the transfer status for a domain.
|
|
1437
|
+
*
|
|
1438
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1439
|
+
* @throws {AppwriteException}
|
|
1440
|
+
* @returns {Promise<Models.DomainTransferStatus>}
|
|
1441
|
+
*/
|
|
1442
|
+
getTransferStatus(params: {
|
|
1443
|
+
domainId: string;
|
|
1444
|
+
}): Promise<Models.DomainTransferStatus>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Get the transfer status for a domain.
|
|
1447
|
+
*
|
|
1448
|
+
* @param {string} domainId - Domain unique ID.
|
|
1449
|
+
* @throws {AppwriteException}
|
|
1450
|
+
* @returns {Promise<Models.DomainTransferStatus>}
|
|
1451
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1452
|
+
*/
|
|
1453
|
+
getTransferStatus(domainId: string): Promise<Models.DomainTransferStatus>;
|
|
1231
1454
|
/**
|
|
1232
1455
|
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1233
1456
|
* zone file in a standardized format that can be used to configure DNS servers.
|
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
import { Client, UploadProgress } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
3
|
import { Runtime } from '../enums/runtime';
|
|
4
|
+
import { Scopes } from '../enums/scopes';
|
|
5
|
+
import { Runtimes } from '../enums/runtimes';
|
|
6
|
+
import { UseCases } from '../enums/use-cases';
|
|
4
7
|
import { UsageRange } from '../enums/usage-range';
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
8
|
+
import { TemplateReferenceType } from '../enums/template-reference-type';
|
|
9
|
+
import { VCSReferenceType } from '../enums/vcs-reference-type';
|
|
7
10
|
import { DeploymentDownloadType } from '../enums/deployment-download-type';
|
|
8
11
|
import { ExecutionMethod } from '../enums/execution-method';
|
|
9
12
|
export declare class Functions {
|
|
@@ -48,13 +51,15 @@ export declare class Functions {
|
|
|
48
51
|
* @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
49
52
|
* @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
50
53
|
* @param {string} params.commands - Build Commands.
|
|
51
|
-
* @param {
|
|
54
|
+
* @param {Scopes[]} params.scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
|
|
52
55
|
* @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
|
|
53
56
|
* @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function.
|
|
54
57
|
* @param {string} params.providerBranch - Production branch for the repo linked to the function.
|
|
55
58
|
* @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
|
|
56
59
|
* @param {string} params.providerRootDirectory - Path to function code in the linked repo.
|
|
57
|
-
* @param {string} params.
|
|
60
|
+
* @param {string} params.buildSpecification - Build specification for the function deployments.
|
|
61
|
+
* @param {string} params.runtimeSpecification - Runtime specification for the function executions.
|
|
62
|
+
* @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
58
63
|
* @throws {AppwriteException}
|
|
59
64
|
* @returns {Promise<Models.Function>}
|
|
60
65
|
*/
|
|
@@ -70,13 +75,15 @@ export declare class Functions {
|
|
|
70
75
|
logging?: boolean;
|
|
71
76
|
entrypoint?: string;
|
|
72
77
|
commands?: string;
|
|
73
|
-
scopes?:
|
|
78
|
+
scopes?: Scopes[];
|
|
74
79
|
installationId?: string;
|
|
75
80
|
providerRepositoryId?: string;
|
|
76
81
|
providerBranch?: string;
|
|
77
82
|
providerSilentMode?: boolean;
|
|
78
83
|
providerRootDirectory?: string;
|
|
79
|
-
|
|
84
|
+
buildSpecification?: string;
|
|
85
|
+
runtimeSpecification?: string;
|
|
86
|
+
deploymentRetention?: number;
|
|
80
87
|
}): Promise<Models.Function>;
|
|
81
88
|
/**
|
|
82
89
|
* Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
|
|
@@ -92,18 +99,20 @@ export declare class Functions {
|
|
|
92
99
|
* @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
93
100
|
* @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
94
101
|
* @param {string} commands - Build Commands.
|
|
95
|
-
* @param {
|
|
102
|
+
* @param {Scopes[]} scopes - List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.
|
|
96
103
|
* @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
|
|
97
104
|
* @param {string} providerRepositoryId - Repository ID of the repo linked to the function.
|
|
98
105
|
* @param {string} providerBranch - Production branch for the repo linked to the function.
|
|
99
106
|
* @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
|
|
100
107
|
* @param {string} providerRootDirectory - Path to function code in the linked repo.
|
|
101
|
-
* @param {string}
|
|
108
|
+
* @param {string} buildSpecification - Build specification for the function deployments.
|
|
109
|
+
* @param {string} runtimeSpecification - Runtime specification for the function executions.
|
|
110
|
+
* @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
102
111
|
* @throws {AppwriteException}
|
|
103
112
|
* @returns {Promise<Models.Function>}
|
|
104
113
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
105
114
|
*/
|
|
106
|
-
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?:
|
|
115
|
+
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
|
|
107
116
|
/**
|
|
108
117
|
* Get a list of all runtimes that are currently active on your instance.
|
|
109
118
|
*
|
|
@@ -121,8 +130,8 @@ export declare class Functions {
|
|
|
121
130
|
/**
|
|
122
131
|
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
123
132
|
*
|
|
124
|
-
* @param {
|
|
125
|
-
* @param {
|
|
133
|
+
* @param {Runtimes[]} params.runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
|
|
134
|
+
* @param {UseCases[]} params.useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
|
|
126
135
|
* @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
127
136
|
* @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
128
137
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
@@ -130,8 +139,8 @@ export declare class Functions {
|
|
|
130
139
|
* @returns {Promise<Models.TemplateFunctionList>}
|
|
131
140
|
*/
|
|
132
141
|
listTemplates(params?: {
|
|
133
|
-
runtimes?:
|
|
134
|
-
useCases?:
|
|
142
|
+
runtimes?: Runtimes[];
|
|
143
|
+
useCases?: UseCases[];
|
|
135
144
|
limit?: number;
|
|
136
145
|
offset?: number;
|
|
137
146
|
total?: boolean;
|
|
@@ -139,8 +148,8 @@ export declare class Functions {
|
|
|
139
148
|
/**
|
|
140
149
|
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
141
150
|
*
|
|
142
|
-
* @param {
|
|
143
|
-
* @param {
|
|
151
|
+
* @param {Runtimes[]} runtimes - List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
|
|
152
|
+
* @param {UseCases[]} useCases - List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.
|
|
144
153
|
* @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
|
|
145
154
|
* @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
|
|
146
155
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
@@ -148,7 +157,7 @@ export declare class Functions {
|
|
|
148
157
|
* @returns {Promise<Models.TemplateFunctionList>}
|
|
149
158
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
150
159
|
*/
|
|
151
|
-
listTemplates(runtimes?:
|
|
160
|
+
listTemplates(runtimes?: Runtimes[], useCases?: UseCases[], limit?: number, offset?: number, total?: boolean): Promise<Models.TemplateFunctionList>;
|
|
152
161
|
/**
|
|
153
162
|
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
|
|
154
163
|
*
|
|
@@ -220,13 +229,15 @@ export declare class Functions {
|
|
|
220
229
|
* @param {boolean} params.logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
221
230
|
* @param {string} params.entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
222
231
|
* @param {string} params.commands - Build Commands.
|
|
223
|
-
* @param {
|
|
232
|
+
* @param {Scopes[]} params.scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
|
|
224
233
|
* @param {string} params.installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
|
|
225
234
|
* @param {string} params.providerRepositoryId - Repository ID of the repo linked to the function
|
|
226
235
|
* @param {string} params.providerBranch - Production branch for the repo linked to the function
|
|
227
236
|
* @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
|
|
228
237
|
* @param {string} params.providerRootDirectory - Path to function code in the linked repo.
|
|
229
|
-
* @param {string} params.
|
|
238
|
+
* @param {string} params.buildSpecification - Build specification for the function deployments.
|
|
239
|
+
* @param {string} params.runtimeSpecification - Runtime specification for the function executions.
|
|
240
|
+
* @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
230
241
|
* @throws {AppwriteException}
|
|
231
242
|
* @returns {Promise<Models.Function>}
|
|
232
243
|
*/
|
|
@@ -242,13 +253,15 @@ export declare class Functions {
|
|
|
242
253
|
logging?: boolean;
|
|
243
254
|
entrypoint?: string;
|
|
244
255
|
commands?: string;
|
|
245
|
-
scopes?:
|
|
256
|
+
scopes?: Scopes[];
|
|
246
257
|
installationId?: string;
|
|
247
258
|
providerRepositoryId?: string;
|
|
248
259
|
providerBranch?: string;
|
|
249
260
|
providerSilentMode?: boolean;
|
|
250
261
|
providerRootDirectory?: string;
|
|
251
|
-
|
|
262
|
+
buildSpecification?: string;
|
|
263
|
+
runtimeSpecification?: string;
|
|
264
|
+
deploymentRetention?: number;
|
|
252
265
|
}): Promise<Models.Function>;
|
|
253
266
|
/**
|
|
254
267
|
* Update function by its unique ID.
|
|
@@ -264,18 +277,20 @@ export declare class Functions {
|
|
|
264
277
|
* @param {boolean} logging - When disabled, executions will exclude logs and errors, and will be slightly faster.
|
|
265
278
|
* @param {string} entrypoint - Entrypoint File. This path is relative to the "providerRootDirectory".
|
|
266
279
|
* @param {string} commands - Build Commands.
|
|
267
|
-
* @param {
|
|
280
|
+
* @param {Scopes[]} scopes - List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.
|
|
268
281
|
* @param {string} installationId - Appwrite Installation ID for VCS (Version Controle System) deployment.
|
|
269
282
|
* @param {string} providerRepositoryId - Repository ID of the repo linked to the function
|
|
270
283
|
* @param {string} providerBranch - Production branch for the repo linked to the function
|
|
271
284
|
* @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
|
|
272
285
|
* @param {string} providerRootDirectory - Path to function code in the linked repo.
|
|
273
|
-
* @param {string}
|
|
286
|
+
* @param {string} buildSpecification - Build specification for the function deployments.
|
|
287
|
+
* @param {string} runtimeSpecification - Runtime specification for the function executions.
|
|
288
|
+
* @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
274
289
|
* @throws {AppwriteException}
|
|
275
290
|
* @returns {Promise<Models.Function>}
|
|
276
291
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
277
292
|
*/
|
|
278
|
-
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?:
|
|
293
|
+
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
|
|
279
294
|
/**
|
|
280
295
|
* Delete a function by its unique ID.
|
|
281
296
|
*
|
|
@@ -419,7 +434,7 @@ export declare class Functions {
|
|
|
419
434
|
* @param {string} params.repository - Repository name of the template.
|
|
420
435
|
* @param {string} params.owner - The name of the owner of the template.
|
|
421
436
|
* @param {string} params.rootDirectory - Path to function code in the template repo.
|
|
422
|
-
* @param {
|
|
437
|
+
* @param {TemplateReferenceType} params.type - Type for the reference provided. Can be commit, branch, or tag
|
|
423
438
|
* @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
|
|
424
439
|
* @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
|
|
425
440
|
* @throws {AppwriteException}
|
|
@@ -430,7 +445,7 @@ export declare class Functions {
|
|
|
430
445
|
repository: string;
|
|
431
446
|
owner: string;
|
|
432
447
|
rootDirectory: string;
|
|
433
|
-
type:
|
|
448
|
+
type: TemplateReferenceType;
|
|
434
449
|
reference: string;
|
|
435
450
|
activate?: boolean;
|
|
436
451
|
}): Promise<Models.Deployment>;
|
|
@@ -443,21 +458,21 @@ export declare class Functions {
|
|
|
443
458
|
* @param {string} repository - Repository name of the template.
|
|
444
459
|
* @param {string} owner - The name of the owner of the template.
|
|
445
460
|
* @param {string} rootDirectory - Path to function code in the template repo.
|
|
446
|
-
* @param {
|
|
461
|
+
* @param {TemplateReferenceType} type - Type for the reference provided. Can be commit, branch, or tag
|
|
447
462
|
* @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
|
|
448
463
|
* @param {boolean} activate - Automatically activate the deployment when it is finished building.
|
|
449
464
|
* @throws {AppwriteException}
|
|
450
465
|
* @returns {Promise<Models.Deployment>}
|
|
451
466
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
452
467
|
*/
|
|
453
|
-
createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, type:
|
|
468
|
+
createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, type: TemplateReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
|
|
454
469
|
/**
|
|
455
470
|
* Create a deployment when a function is connected to VCS.
|
|
456
471
|
*
|
|
457
472
|
* This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
458
473
|
*
|
|
459
474
|
* @param {string} params.functionId - Function ID.
|
|
460
|
-
* @param {
|
|
475
|
+
* @param {VCSReferenceType} params.type - Type of reference passed. Allowed values are: branch, commit
|
|
461
476
|
* @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
|
|
462
477
|
* @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
|
|
463
478
|
* @throws {AppwriteException}
|
|
@@ -465,7 +480,7 @@ export declare class Functions {
|
|
|
465
480
|
*/
|
|
466
481
|
createVcsDeployment(params: {
|
|
467
482
|
functionId: string;
|
|
468
|
-
type:
|
|
483
|
+
type: VCSReferenceType;
|
|
469
484
|
reference: string;
|
|
470
485
|
activate?: boolean;
|
|
471
486
|
}): Promise<Models.Deployment>;
|
|
@@ -475,14 +490,14 @@ export declare class Functions {
|
|
|
475
490
|
* This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
476
491
|
*
|
|
477
492
|
* @param {string} functionId - Function ID.
|
|
478
|
-
* @param {
|
|
493
|
+
* @param {VCSReferenceType} type - Type of reference passed. Allowed values are: branch, commit
|
|
479
494
|
* @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
|
|
480
495
|
* @param {boolean} activate - Automatically activate the deployment when it is finished building.
|
|
481
496
|
* @throws {AppwriteException}
|
|
482
497
|
* @returns {Promise<Models.Deployment>}
|
|
483
498
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
484
499
|
*/
|
|
485
|
-
createVcsDeployment(functionId: string, type:
|
|
500
|
+
createVcsDeployment(functionId: string, type: VCSReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
|
|
486
501
|
/**
|
|
487
502
|
* Get a function deployment by its unique ID.
|
|
488
503
|
*
|
|
@@ -22,9 +22,9 @@ export declare class Health {
|
|
|
22
22
|
* Check the Appwrite in-memory cache servers are up and connection is successful.
|
|
23
23
|
*
|
|
24
24
|
* @throws {AppwriteException}
|
|
25
|
-
* @returns {Promise<Models.
|
|
25
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
26
26
|
*/
|
|
27
|
-
getCache(): Promise<Models.
|
|
27
|
+
getCache(): Promise<Models.HealthStatusList>;
|
|
28
28
|
/**
|
|
29
29
|
* Get the SSL certificate for a domain
|
|
30
30
|
*
|
|
@@ -45,19 +45,62 @@ export declare class Health {
|
|
|
45
45
|
*/
|
|
46
46
|
getCertificate(domain?: string): Promise<Models.HealthCertificate>;
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
48
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
49
49
|
*
|
|
50
|
+
*
|
|
51
|
+
* @param {number} params.threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
52
|
+
* @param {number} params.inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
50
53
|
* @throws {AppwriteException}
|
|
51
54
|
* @returns {Promise<Models.HealthStatus>}
|
|
52
55
|
*/
|
|
53
|
-
|
|
56
|
+
getConsolePausing(params?: {
|
|
57
|
+
threshold?: number;
|
|
58
|
+
inactivityDays?: number;
|
|
59
|
+
}): Promise<Models.HealthStatus>;
|
|
54
60
|
/**
|
|
55
|
-
*
|
|
61
|
+
* Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
|
|
62
|
+
*
|
|
56
63
|
*
|
|
64
|
+
* @param {number} threshold - Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.
|
|
65
|
+
* @param {number} inactivityDays - Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.
|
|
57
66
|
* @throws {AppwriteException}
|
|
58
67
|
* @returns {Promise<Models.HealthStatus>}
|
|
68
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
69
|
+
*/
|
|
70
|
+
getConsolePausing(threshold?: number, inactivityDays?: number): Promise<Models.HealthStatus>;
|
|
71
|
+
/**
|
|
72
|
+
* Check the Appwrite database servers are up and connection is successful.
|
|
73
|
+
*
|
|
74
|
+
* @throws {AppwriteException}
|
|
75
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
76
|
+
*/
|
|
77
|
+
getDB(): Promise<Models.HealthStatusList>;
|
|
78
|
+
/**
|
|
79
|
+
* Check the Appwrite pub-sub servers are up and connection is successful.
|
|
80
|
+
*
|
|
81
|
+
* @throws {AppwriteException}
|
|
82
|
+
* @returns {Promise<Models.HealthStatusList>}
|
|
83
|
+
*/
|
|
84
|
+
getPubSub(): Promise<Models.HealthStatusList>;
|
|
85
|
+
/**
|
|
86
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
87
|
+
*
|
|
88
|
+
* @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
89
|
+
* @throws {AppwriteException}
|
|
90
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
91
|
+
*/
|
|
92
|
+
getQueueAudits(params?: {
|
|
93
|
+
threshold?: number;
|
|
94
|
+
}): Promise<Models.HealthQueue>;
|
|
95
|
+
/**
|
|
96
|
+
* Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.
|
|
97
|
+
*
|
|
98
|
+
* @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
|
|
99
|
+
* @throws {AppwriteException}
|
|
100
|
+
* @returns {Promise<Models.HealthQueue>}
|
|
101
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
59
102
|
*/
|
|
60
|
-
|
|
103
|
+
getQueueAudits(threshold?: number): Promise<Models.HealthQueue>;
|
|
61
104
|
/**
|
|
62
105
|
* Get billing project aggregation queue.
|
|
63
106
|
*
|
|
@@ -1891,7 +1891,7 @@ export declare class Messaging {
|
|
|
1891
1891
|
* Get a list of all subscribers from the current Appwrite project.
|
|
1892
1892
|
*
|
|
1893
1893
|
* @param {string} params.topicId - Topic ID. The topic ID subscribed to.
|
|
1894
|
-
* @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:
|
|
1894
|
+
* @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: targetId, topicId, userId, providerType
|
|
1895
1895
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
1896
1896
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1897
1897
|
* @throws {AppwriteException}
|
|
@@ -1907,7 +1907,7 @@ export declare class Messaging {
|
|
|
1907
1907
|
* Get a list of all subscribers from the current Appwrite project.
|
|
1908
1908
|
*
|
|
1909
1909
|
* @param {string} topicId - Topic ID. The topic ID subscribed to.
|
|
1910
|
-
* @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:
|
|
1910
|
+
* @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: targetId, topicId, userId, providerType
|
|
1911
1911
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
1912
1912
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1913
1913
|
* @throws {AppwriteException}
|