@appwrite.io/console 1.9.0 → 1.10.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 +45 -6
- package/README.md +82 -2
- package/dist/cjs/sdk.js +246 -193
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +246 -193
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +246 -193
- package/docs/examples/databases/create-document.md +1 -3
- package/docs/examples/databases/create-documents.md +1 -1
- package/docs/examples/functions/create-execution.md +1 -1
- package/docs/examples/organizations/get-available-credits.md +13 -0
- package/docs/examples/organizations/update-projects.md +14 -0
- package/docs/examples/vcs/get-repository-contents.md +2 -1
- package/package.json +1 -1
- package/src/client.ts +1 -1
- package/src/models.ts +241 -9
- package/src/services/account.ts +97 -36
- package/src/services/avatars.ts +26 -20
- package/src/services/backups.ts +11 -0
- package/src/services/console.ts +8 -1
- package/src/services/databases.ts +97 -33
- package/src/services/domains.ts +111 -69
- package/src/services/functions.ts +37 -8
- package/src/services/graphql.ts +1 -0
- package/src/services/health.ts +26 -1
- package/src/services/locale.ts +9 -2
- package/src/services/messaging.ts +53 -8
- package/src/services/migrations.ts +12 -0
- package/src/services/organizations.ts +106 -16
- package/src/services/project.ts +5 -0
- package/src/services/projects.ts +50 -0
- package/src/services/proxy.ts +7 -0
- package/src/services/sites.ts +32 -4
- package/src/services/storage.ts +23 -9
- package/src/services/teams.ts +30 -17
- package/src/services/tokens.ts +4 -0
- package/src/services/users.ts +69 -27
- package/src/services/vcs.ts +16 -4
- package/types/models.d.ts +228 -192
- package/types/services/account.d.ts +36 -36
- package/types/services/avatars.d.ts +20 -20
- package/types/services/console.d.ts +1 -1
- package/types/services/databases.d.ts +43 -33
- package/types/services/domains.d.ts +69 -69
- package/types/services/functions.d.ts +8 -8
- package/types/services/health.d.ts +1 -1
- package/types/services/locale.d.ts +2 -2
- package/types/services/messaging.d.ts +8 -8
- package/types/services/organizations.d.ts +33 -16
- package/types/services/sites.d.ts +4 -4
- package/types/services/storage.d.ts +9 -9
- package/types/services/teams.d.ts +17 -17
- package/types/services/users.d.ts +27 -27
- package/types/services/vcs.d.ts +4 -4
|
@@ -31,7 +31,7 @@ export declare class Domains {
|
|
|
31
31
|
get(domainId: string): Promise<Models.Domain>;
|
|
32
32
|
/**
|
|
33
33
|
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
34
|
-
Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
34
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
35
35
|
*
|
|
36
36
|
* @param {string} domainId
|
|
37
37
|
* @throws {AppwriteException}
|
|
@@ -40,8 +40,8 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
40
40
|
delete(domainId: string): Promise<{}>;
|
|
41
41
|
/**
|
|
42
42
|
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
43
|
-
|
|
44
|
-
|
|
43
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
44
|
+
* Appwrite nameservers.
|
|
45
45
|
*
|
|
46
46
|
* @param {string} domainId
|
|
47
47
|
* @throws {AppwriteException}
|
|
@@ -58,7 +58,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
58
58
|
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
59
59
|
/**
|
|
60
60
|
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
61
|
-
|
|
61
|
+
* for Google Workspace email hosting.
|
|
62
62
|
*
|
|
63
63
|
* @param {string} domainId
|
|
64
64
|
* @throws {AppwriteException}
|
|
@@ -75,7 +75,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
75
75
|
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
76
76
|
/**
|
|
77
77
|
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
78
|
-
|
|
78
|
+
* for using iCloud email services with your domain.
|
|
79
79
|
*
|
|
80
80
|
* @param {string} domainId
|
|
81
81
|
* @throws {AppwriteException}
|
|
@@ -92,7 +92,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
92
92
|
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
93
93
|
/**
|
|
94
94
|
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
95
|
-
|
|
95
|
+
* for Mailgun in the specified domain.
|
|
96
96
|
*
|
|
97
97
|
* @param {string} domainId
|
|
98
98
|
* @throws {AppwriteException}
|
|
@@ -109,7 +109,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
109
109
|
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
110
110
|
/**
|
|
111
111
|
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
112
|
-
|
|
112
|
+
* for setting up Outlook email hosting for your domain.
|
|
113
113
|
*
|
|
114
114
|
* @param {string} domainId
|
|
115
115
|
* @throws {AppwriteException}
|
|
@@ -126,7 +126,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
126
126
|
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
127
127
|
/**
|
|
128
128
|
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
129
|
-
|
|
129
|
+
* for using ProtonMail with your custom domain.
|
|
130
130
|
*
|
|
131
131
|
* @param {string} domainId
|
|
132
132
|
* @throws {AppwriteException}
|
|
@@ -143,7 +143,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
143
143
|
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
144
144
|
/**
|
|
145
145
|
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
146
|
-
|
|
146
|
+
* for setting up Zoho Mail on your domain.
|
|
147
147
|
*
|
|
148
148
|
* @param {string} domainId
|
|
149
149
|
* @throws {AppwriteException}
|
|
@@ -152,7 +152,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
152
152
|
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
153
153
|
/**
|
|
154
154
|
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
155
|
-
|
|
155
|
+
* associated with your domain.
|
|
156
156
|
*
|
|
157
157
|
* @param {string} domainId
|
|
158
158
|
* @param {string[]} queries
|
|
@@ -162,7 +162,7 @@ Once deleted, the domain will no longer be available for use and all associated
|
|
|
162
162
|
listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
|
|
163
163
|
/**
|
|
164
164
|
* Create a new A record for the given domain. A records are used to point a domain name
|
|
165
|
-
to an IPv4 address. The record value should be a valid IPv4 address.
|
|
165
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
166
166
|
*
|
|
167
167
|
* @param {string} domainId
|
|
168
168
|
* @param {string} name
|
|
@@ -175,8 +175,8 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
175
175
|
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
176
176
|
/**
|
|
177
177
|
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
178
|
-
|
|
179
|
-
|
|
178
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
179
|
+
* and optional comment.
|
|
180
180
|
*
|
|
181
181
|
* @param {string} domainId
|
|
182
182
|
* @param {string} recordId
|
|
@@ -190,7 +190,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
190
190
|
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
191
191
|
/**
|
|
192
192
|
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
193
|
-
|
|
193
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
194
194
|
*
|
|
195
195
|
* @param {string} domainId
|
|
196
196
|
* @param {string} name
|
|
@@ -203,8 +203,8 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
203
203
|
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
204
204
|
/**
|
|
205
205
|
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
206
|
-
|
|
207
|
-
|
|
206
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
207
|
+
* TTL, and optional comment.
|
|
208
208
|
*
|
|
209
209
|
* @param {string} domainId
|
|
210
210
|
* @param {string} recordId
|
|
@@ -218,8 +218,8 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
218
218
|
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
219
219
|
/**
|
|
220
220
|
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
221
|
-
|
|
222
|
-
|
|
221
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
222
|
+
* map your domain to a target domain that may change its IP address.
|
|
223
223
|
*
|
|
224
224
|
* @param {string} domainId
|
|
225
225
|
* @param {string} name
|
|
@@ -232,10 +232,10 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
232
232
|
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
233
233
|
/**
|
|
234
234
|
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
235
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
236
|
+
*
|
|
237
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
238
|
+
* It provides a way to map one domain name to another.
|
|
239
239
|
*
|
|
240
240
|
* @param {string} domainId
|
|
241
241
|
* @param {string} recordId
|
|
@@ -249,7 +249,7 @@ to an IPv4 address. The record value should be a valid IPv4 address.
|
|
|
249
249
|
updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
250
250
|
/**
|
|
251
251
|
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
252
|
-
Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
252
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
253
253
|
*
|
|
254
254
|
* @param {string} domainId
|
|
255
255
|
* @param {string} name
|
|
@@ -262,8 +262,8 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
262
262
|
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
263
263
|
/**
|
|
264
264
|
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
265
|
-
|
|
266
|
-
|
|
265
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
266
|
+
* for a domain.
|
|
267
267
|
*
|
|
268
268
|
* @param {string} domainId
|
|
269
269
|
* @param {string} recordId
|
|
@@ -277,10 +277,10 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
277
277
|
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
278
278
|
/**
|
|
279
279
|
* Create a new CNAME record for the given domain.
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
280
|
+
*
|
|
281
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
282
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
283
|
+
* to 'example.wordpress.com'.
|
|
284
284
|
*
|
|
285
285
|
* @param {string} domainId
|
|
286
286
|
* @param {string} name
|
|
@@ -306,7 +306,7 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
306
306
|
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
307
307
|
/**
|
|
308
308
|
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
309
|
-
|
|
309
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
310
310
|
*
|
|
311
311
|
* @param {string} domainId
|
|
312
312
|
* @param {string} name
|
|
@@ -319,8 +319,8 @@ Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your
|
|
|
319
319
|
createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
320
320
|
/**
|
|
321
321
|
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
322
|
-
the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
323
|
-
target value, TTL, and optional comment.
|
|
322
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
323
|
+
* target value, TTL, and optional comment.
|
|
324
324
|
*
|
|
325
325
|
* @param {string} domainId
|
|
326
326
|
* @param {string} recordId
|
|
@@ -334,9 +334,9 @@ target value, TTL, and optional comment.
|
|
|
334
334
|
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
335
335
|
/**
|
|
336
336
|
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
337
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
338
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
339
|
+
* higher priority.
|
|
340
340
|
*
|
|
341
341
|
* @param {string} domainId
|
|
342
342
|
* @param {string} name
|
|
@@ -364,7 +364,7 @@ target value, TTL, and optional comment.
|
|
|
364
364
|
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
365
365
|
/**
|
|
366
366
|
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
367
|
-
|
|
367
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
368
368
|
*
|
|
369
369
|
* @param {string} domainId
|
|
370
370
|
* @param {string} name
|
|
@@ -377,9 +377,9 @@ target value, TTL, and optional comment.
|
|
|
377
377
|
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
378
378
|
/**
|
|
379
379
|
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
380
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
381
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
382
|
+
* for better record management.
|
|
383
383
|
*
|
|
384
384
|
* @param {string} domainId
|
|
385
385
|
* @param {string} recordId
|
|
@@ -393,8 +393,8 @@ target value, TTL, and optional comment.
|
|
|
393
393
|
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
394
394
|
/**
|
|
395
395
|
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
396
|
-
|
|
397
|
-
|
|
396
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
397
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
398
398
|
*
|
|
399
399
|
* @param {string} domainId
|
|
400
400
|
* @param {string} name
|
|
@@ -410,19 +410,19 @@ target value, TTL, and optional comment.
|
|
|
410
410
|
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
411
411
|
/**
|
|
412
412
|
* Update an existing SRV record for the given domain.
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
413
|
+
*
|
|
414
|
+
* Required parameters:
|
|
415
|
+
* - domainId: Domain unique ID
|
|
416
|
+
* - recordId: DNS record unique ID
|
|
417
|
+
* - name: Record name (service name)
|
|
418
|
+
* - value: Target hostname for this SRV record
|
|
419
|
+
* - ttl: Time to live, in seconds
|
|
420
|
+
* - priority: Record priority
|
|
421
|
+
* - weight: Record weight
|
|
422
|
+
* - port: Port number for the service
|
|
423
|
+
*
|
|
424
|
+
* Optional parameters:
|
|
425
|
+
* - comment: A comment for this record
|
|
426
426
|
*
|
|
427
427
|
* @param {string} domainId
|
|
428
428
|
* @param {string} recordId
|
|
@@ -439,8 +439,8 @@ target value, TTL, and optional comment.
|
|
|
439
439
|
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
440
440
|
/**
|
|
441
441
|
* Create a new TXT record for the given domain. TXT records can be used
|
|
442
|
-
|
|
443
|
-
|
|
442
|
+
* to provide additional information about your domain, such as domain
|
|
443
|
+
* verification records, SPF records, or DKIM records.
|
|
444
444
|
*
|
|
445
445
|
* @param {string} domainId
|
|
446
446
|
* @param {string} name
|
|
@@ -453,9 +453,9 @@ target value, TTL, and optional comment.
|
|
|
453
453
|
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
|
|
454
454
|
/**
|
|
455
455
|
* Update an existing TXT record for the given domain.
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
456
|
+
*
|
|
457
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
458
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
459
459
|
*
|
|
460
460
|
* @param {string} domainId
|
|
461
461
|
* @param {string} recordId
|
|
@@ -469,10 +469,10 @@ target value, TTL, and optional comment.
|
|
|
469
469
|
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
470
470
|
/**
|
|
471
471
|
* Get a single DNS record for a given domain by record ID.
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
472
|
+
*
|
|
473
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
474
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
475
|
+
* such as type, value, and TTL settings.
|
|
476
476
|
*
|
|
477
477
|
* @param {string} domainId
|
|
478
478
|
* @param {string} recordId
|
|
@@ -482,7 +482,7 @@ target value, TTL, and optional comment.
|
|
|
482
482
|
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
|
|
483
483
|
/**
|
|
484
484
|
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
485
|
-
|
|
485
|
+
* from a specific domain.
|
|
486
486
|
*
|
|
487
487
|
* @param {string} domainId
|
|
488
488
|
* @param {string} recordId
|
|
@@ -492,9 +492,9 @@ target value, TTL, and optional comment.
|
|
|
492
492
|
deleteRecord(domainId: string, recordId: string): Promise<{}>;
|
|
493
493
|
/**
|
|
494
494
|
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
495
|
+
*
|
|
496
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
497
|
+
* and all its DNS records to the new team.
|
|
498
498
|
*
|
|
499
499
|
* @param {string} domainId
|
|
500
500
|
* @param {string} teamId
|
|
@@ -504,7 +504,7 @@ target value, TTL, and optional comment.
|
|
|
504
504
|
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
505
505
|
/**
|
|
506
506
|
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
507
|
-
|
|
507
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
508
508
|
*
|
|
509
509
|
* @param {string} domainId
|
|
510
510
|
* @throws {AppwriteException}
|
|
@@ -513,7 +513,7 @@ target value, TTL, and optional comment.
|
|
|
513
513
|
getZone(domainId: string): Promise<{}>;
|
|
514
514
|
/**
|
|
515
515
|
* Update the DNS zone for the given domain using the provided zone file content.
|
|
516
|
-
All parsed records are imported and then the main domain document is returned.
|
|
516
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
517
517
|
*
|
|
518
518
|
* @param {string} domainId
|
|
519
519
|
* @param {string} content
|
|
@@ -145,10 +145,10 @@ export declare class Functions {
|
|
|
145
145
|
listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
|
|
146
146
|
/**
|
|
147
147
|
* Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.
|
|
148
|
-
|
|
149
|
-
This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
|
|
150
|
-
|
|
151
|
-
Use the "command" param to set the entrypoint used to execute your code.
|
|
148
|
+
*
|
|
149
|
+
* This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https://appwrite.io/docs/functions).
|
|
150
|
+
*
|
|
151
|
+
* Use the "command" param to set the entrypoint used to execute your code.
|
|
152
152
|
*
|
|
153
153
|
* @param {string} functionId
|
|
154
154
|
* @param {File} code
|
|
@@ -171,8 +171,8 @@ Use the "command" param to set the entrypoint used to execute your cod
|
|
|
171
171
|
createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment>;
|
|
172
172
|
/**
|
|
173
173
|
* Create a deployment based on a template.
|
|
174
|
-
|
|
175
|
-
Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
|
|
174
|
+
*
|
|
175
|
+
* Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
|
|
176
176
|
*
|
|
177
177
|
* @param {string} functionId
|
|
178
178
|
* @param {string} repository
|
|
@@ -186,8 +186,8 @@ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/s
|
|
|
186
186
|
createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
|
|
187
187
|
/**
|
|
188
188
|
* Create a deployment when a function is connected to VCS.
|
|
189
|
-
|
|
190
|
-
This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
189
|
+
*
|
|
190
|
+
* This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
191
191
|
*
|
|
192
192
|
* @param {string} functionId
|
|
193
193
|
* @param {VCSDeploymentType} type
|
|
@@ -5,8 +5,8 @@ export declare class Locale {
|
|
|
5
5
|
constructor(client: Client);
|
|
6
6
|
/**
|
|
7
7
|
* Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
|
|
8
|
-
|
|
9
|
-
([IP Geolocation by DB-IP](https://db-ip.com))
|
|
8
|
+
*
|
|
9
|
+
* ([IP Geolocation by DB-IP](https://db-ip.com))
|
|
10
10
|
*
|
|
11
11
|
* @throws {AppwriteException}
|
|
12
12
|
* @returns {Promise<Models.Locale>}
|
|
@@ -35,7 +35,7 @@ export declare class Messaging {
|
|
|
35
35
|
createEmail(messageId: string, subject: string, content: string, topics?: string[], users?: string[], targets?: string[], cc?: string[], bcc?: string[], attachments?: string[], draft?: boolean, html?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
36
36
|
/**
|
|
37
37
|
* Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
38
|
-
|
|
38
|
+
*
|
|
39
39
|
*
|
|
40
40
|
* @param {string} messageId
|
|
41
41
|
* @param {string[]} topics
|
|
@@ -81,7 +81,7 @@ export declare class Messaging {
|
|
|
81
81
|
createPush(messageId: string, title?: string, body?: string, topics?: string[], users?: string[], targets?: string[], data?: object, action?: string, image?: string, icon?: string, sound?: string, color?: string, tag?: string, badge?: number, draft?: boolean, scheduledAt?: string, contentAvailable?: boolean, critical?: boolean, priority?: MessagePriority): Promise<Models.Message>;
|
|
82
82
|
/**
|
|
83
83
|
* Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
84
|
-
|
|
84
|
+
*
|
|
85
85
|
*
|
|
86
86
|
* @param {string} messageId
|
|
87
87
|
* @param {string[]} topics
|
|
@@ -122,7 +122,7 @@ export declare class Messaging {
|
|
|
122
122
|
createSms(messageId: string, content: string, topics?: string[], users?: string[], targets?: string[], draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
123
123
|
/**
|
|
124
124
|
* Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.
|
|
125
|
-
|
|
125
|
+
*
|
|
126
126
|
*
|
|
127
127
|
* @param {string} messageId
|
|
128
128
|
* @param {string[]} topics
|
|
@@ -137,7 +137,7 @@ export declare class Messaging {
|
|
|
137
137
|
updateSms(messageId: string, topics?: string[], users?: string[], targets?: string[], content?: string, draft?: boolean, scheduledAt?: string): Promise<Models.Message>;
|
|
138
138
|
/**
|
|
139
139
|
* Get a message by its unique ID.
|
|
140
|
-
|
|
140
|
+
*
|
|
141
141
|
*
|
|
142
142
|
* @param {string} messageId
|
|
143
143
|
* @throws {AppwriteException}
|
|
@@ -469,7 +469,7 @@ export declare class Messaging {
|
|
|
469
469
|
updateVonageProvider(providerId: string, name?: string, enabled?: boolean, apiKey?: string, apiSecret?: string, from?: string): Promise<Models.Provider>;
|
|
470
470
|
/**
|
|
471
471
|
* Get a provider by its unique ID.
|
|
472
|
-
|
|
472
|
+
*
|
|
473
473
|
*
|
|
474
474
|
* @param {string} providerId
|
|
475
475
|
* @throws {AppwriteException}
|
|
@@ -523,7 +523,7 @@ export declare class Messaging {
|
|
|
523
523
|
createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
524
524
|
/**
|
|
525
525
|
* Get a topic by its unique ID.
|
|
526
|
-
|
|
526
|
+
*
|
|
527
527
|
*
|
|
528
528
|
* @param {string} topicId
|
|
529
529
|
* @throws {AppwriteException}
|
|
@@ -532,7 +532,7 @@ export declare class Messaging {
|
|
|
532
532
|
getTopic(topicId: string): Promise<Models.Topic>;
|
|
533
533
|
/**
|
|
534
534
|
* Update a topic by its unique ID.
|
|
535
|
-
|
|
535
|
+
*
|
|
536
536
|
*
|
|
537
537
|
* @param {string} topicId
|
|
538
538
|
* @param {string} name
|
|
@@ -580,7 +580,7 @@ export declare class Messaging {
|
|
|
580
580
|
createSubscriber(topicId: string, subscriberId: string, targetId: string): Promise<Models.Subscriber>;
|
|
581
581
|
/**
|
|
582
582
|
* Get a subscriber by its unique ID.
|
|
583
|
-
|
|
583
|
+
*
|
|
584
584
|
*
|
|
585
585
|
* @param {string} topicId
|
|
586
586
|
* @param {string} subscriberId
|
|
@@ -12,10 +12,10 @@ export declare class Organizations {
|
|
|
12
12
|
* @throws {AppwriteException}
|
|
13
13
|
* @returns {Promise<Models.OrganizationList<Preferences>>}
|
|
14
14
|
*/
|
|
15
|
-
list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
|
|
15
|
+
list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
|
|
16
16
|
/**
|
|
17
17
|
* Create a new organization.
|
|
18
|
-
|
|
18
|
+
*
|
|
19
19
|
*
|
|
20
20
|
* @param {string} organizationId
|
|
21
21
|
* @param {string} name
|
|
@@ -29,7 +29,7 @@ export declare class Organizations {
|
|
|
29
29
|
* @throws {AppwriteException}
|
|
30
30
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
31
31
|
*/
|
|
32
|
-
create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
32
|
+
create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
33
33
|
/**
|
|
34
34
|
* Get estimation for creating an organization.
|
|
35
35
|
*
|
|
@@ -75,7 +75,7 @@ export declare class Organizations {
|
|
|
75
75
|
* @throws {AppwriteException}
|
|
76
76
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
77
77
|
*/
|
|
78
|
-
setBillingAddress<Preferences extends Models.Preferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
|
|
78
|
+
setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
|
|
79
79
|
/**
|
|
80
80
|
* Delete a team's billing address.
|
|
81
81
|
*
|
|
@@ -101,7 +101,7 @@ export declare class Organizations {
|
|
|
101
101
|
* @throws {AppwriteException}
|
|
102
102
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
103
103
|
*/
|
|
104
|
-
setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
|
|
104
|
+
setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
|
|
105
105
|
/**
|
|
106
106
|
* Update the budget limit for an organization.
|
|
107
107
|
*
|
|
@@ -111,10 +111,10 @@ export declare class Organizations {
|
|
|
111
111
|
* @throws {AppwriteException}
|
|
112
112
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
113
113
|
*/
|
|
114
|
-
updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
|
|
114
|
+
updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
|
|
115
115
|
/**
|
|
116
116
|
* List all credits for an organization.
|
|
117
|
-
|
|
117
|
+
*
|
|
118
118
|
*
|
|
119
119
|
* @param {string} organizationId
|
|
120
120
|
* @param {string[]} queries
|
|
@@ -131,6 +131,14 @@ export declare class Organizations {
|
|
|
131
131
|
* @returns {Promise<Models.Credit>}
|
|
132
132
|
*/
|
|
133
133
|
addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
|
|
134
|
+
/**
|
|
135
|
+
* Get total available valid credits for an organization.
|
|
136
|
+
*
|
|
137
|
+
* @param {string} organizationId
|
|
138
|
+
* @throws {AppwriteException}
|
|
139
|
+
* @returns {Promise<Models.CreditAvailable>}
|
|
140
|
+
*/
|
|
141
|
+
getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable>;
|
|
134
142
|
/**
|
|
135
143
|
* Get credit details.
|
|
136
144
|
*
|
|
@@ -222,7 +230,7 @@ export declare class Organizations {
|
|
|
222
230
|
* @throws {AppwriteException}
|
|
223
231
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
224
232
|
*/
|
|
225
|
-
setDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
233
|
+
setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
226
234
|
/**
|
|
227
235
|
* Delete the default payment method for an organization.
|
|
228
236
|
*
|
|
@@ -230,17 +238,17 @@ export declare class Organizations {
|
|
|
230
238
|
* @throws {AppwriteException}
|
|
231
239
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
232
240
|
*/
|
|
233
|
-
deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
241
|
+
deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
234
242
|
/**
|
|
235
243
|
* Set an organization's backup payment method.
|
|
236
|
-
|
|
244
|
+
*
|
|
237
245
|
*
|
|
238
246
|
* @param {string} organizationId
|
|
239
247
|
* @param {string} paymentMethodId
|
|
240
248
|
* @throws {AppwriteException}
|
|
241
249
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
242
250
|
*/
|
|
243
|
-
setBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
251
|
+
setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
|
|
244
252
|
/**
|
|
245
253
|
* Delete a backup payment method for an organization.
|
|
246
254
|
*
|
|
@@ -248,7 +256,7 @@ export declare class Organizations {
|
|
|
248
256
|
* @throws {AppwriteException}
|
|
249
257
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
250
258
|
*/
|
|
251
|
-
deleteBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
259
|
+
deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
252
260
|
/**
|
|
253
261
|
* Get an organization's payment method using it's payment method ID.
|
|
254
262
|
*
|
|
@@ -280,7 +288,7 @@ export declare class Organizations {
|
|
|
280
288
|
* @throws {AppwriteException}
|
|
281
289
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
282
290
|
*/
|
|
283
|
-
updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
291
|
+
updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
|
|
284
292
|
/**
|
|
285
293
|
* Cancel the downgrade initiated for an organization.
|
|
286
294
|
*
|
|
@@ -288,7 +296,16 @@ export declare class Organizations {
|
|
|
288
296
|
* @throws {AppwriteException}
|
|
289
297
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
290
298
|
*/
|
|
291
|
-
cancelDowngrade<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
299
|
+
cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
|
|
300
|
+
/**
|
|
301
|
+
* Update selected projects to keep in the organization.
|
|
302
|
+
*
|
|
303
|
+
* @param {string} organizationId
|
|
304
|
+
* @param {string[]} projects
|
|
305
|
+
* @throws {AppwriteException}
|
|
306
|
+
* @returns {Promise<Models.Organization<Preferences>>}
|
|
307
|
+
*/
|
|
308
|
+
updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
|
|
292
309
|
/**
|
|
293
310
|
* Get Scopes
|
|
294
311
|
*
|
|
@@ -305,7 +322,7 @@ export declare class Organizations {
|
|
|
305
322
|
* @throws {AppwriteException}
|
|
306
323
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
307
324
|
*/
|
|
308
|
-
setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
|
|
325
|
+
setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
|
|
309
326
|
/**
|
|
310
327
|
* Get the usage data for an organization.
|
|
311
328
|
*
|
|
@@ -324,5 +341,5 @@ export declare class Organizations {
|
|
|
324
341
|
* @throws {AppwriteException}
|
|
325
342
|
* @returns {Promise<Models.Organization<Preferences>>}
|
|
326
343
|
*/
|
|
327
|
-
validatePayment<Preferences extends Models.Preferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
|
|
344
|
+
validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
|
|
328
345
|
}
|
|
@@ -168,8 +168,8 @@ export declare class Sites {
|
|
|
168
168
|
createDuplicateDeployment(siteId: string, deploymentId: string): Promise<Models.Deployment>;
|
|
169
169
|
/**
|
|
170
170
|
* Create a deployment based on a template.
|
|
171
|
-
|
|
172
|
-
Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
|
|
171
|
+
*
|
|
172
|
+
* Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to find the template details.
|
|
173
173
|
*
|
|
174
174
|
* @param {string} siteId
|
|
175
175
|
* @param {string} repository
|
|
@@ -183,8 +183,8 @@ Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/s
|
|
|
183
183
|
createTemplateDeployment(siteId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
|
|
184
184
|
/**
|
|
185
185
|
* Create a deployment when a site is connected to VCS.
|
|
186
|
-
|
|
187
|
-
This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
186
|
+
*
|
|
187
|
+
* This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
188
188
|
*
|
|
189
189
|
* @param {string} siteId
|
|
190
190
|
* @param {VCSDeploymentType} type
|