@appwrite.io/console 13.0.0 → 13.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/README.md +2 -2
- package/dist/cjs/sdk.js +1658 -1162
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +1656 -1163
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +1676 -1180
- package/package.json +1 -1
- package/types/channel.d.ts +8 -3
- package/types/client.d.ts +1 -1
- package/types/enums/account-key-scopes.d.ts +5 -0
- package/types/enums/appwrite-migration-resource.d.ts +1 -0
- package/types/enums/backup-services.d.ts +1 -0
- package/types/enums/{resource-type.d.ts → block-resource-type.d.ts} +2 -6
- package/types/enums/{theme.d.ts → browser-theme.d.ts} +1 -1
- package/types/enums/cache-database.d.ts +5 -0
- package/types/enums/cache-target.d.ts +8 -0
- package/types/enums/{registration-type.d.ts → domain-registration-type.d.ts} +1 -1
- package/types/enums/{filter-type.d.ts → domain-suggestion-type.d.ts} +1 -1
- package/types/enums/{model.d.ts → embedding-model.d.ts} +1 -1
- package/types/enums/{runtime.d.ts → function-runtime.d.ts} +4 -2
- package/types/enums/function-template-use-case.d.ts +9 -0
- package/types/enums/{name.d.ts → health-queue-name.d.ts} +1 -1
- package/types/enums/{on-duplicate.d.ts → migration-on-duplicate.d.ts} +1 -1
- package/types/enums/o-auth-provider.d.ts +1 -3
- package/types/enums/organization-addon.d.ts +4 -0
- package/types/enums/organization-key-scopes.d.ts +12 -0
- package/types/enums/{auth-method.d.ts → project-auth-method-id.d.ts} +1 -1
- package/types/enums/{email-template-type.d.ts → project-email-template-id.d.ts} +1 -1
- package/types/enums/{email-template-locale.d.ts → project-email-template-locale.d.ts} +1 -1
- package/types/enums/{scopes.d.ts → project-key-scopes.d.ts} +10 -8
- package/types/enums/{prompt.d.ts → project-o-auth-2-google-prompt.d.ts} +1 -1
- package/types/enums/project-o-auth-provider-id.d.ts +45 -0
- package/types/enums/{project-policy.d.ts → project-policy-id.d.ts} +1 -1
- package/types/enums/{protocol-id.d.ts → project-protocol-id.d.ts} +1 -1
- package/types/enums/{service-id.d.ts → project-service-id.d.ts} +3 -2
- package/types/enums/project-smtp-secure.d.ts +4 -0
- package/types/enums/project-status.d.ts +3 -0
- package/types/enums/query-suggestion-resource.d.ts +10 -1
- package/types/enums/redirect-status-code.d.ts +6 -0
- package/types/enums/schedule-resource-type.d.ts +6 -0
- package/types/enums/{adapter.d.ts → site-adapter.d.ts} +1 -1
- package/types/enums/{runtimes.d.ts → site-build-runtime.d.ts} +4 -2
- package/types/enums/{framework.d.ts → site-framework.d.ts} +1 -1
- package/types/enums/{use-cases.d.ts → site-template-use-case.d.ts} +3 -8
- package/types/index.d.ts +35 -27
- package/types/models.d.ts +1183 -1187
- package/types/services/account.d.ts +9 -9
- package/types/services/avatars.d.ts +5 -5
- package/types/services/console.d.ts +31 -0
- package/types/services/documents-db.d.ts +1 -4
- package/types/services/domains.d.ts +216 -216
- package/types/services/functions.d.ts +36 -25
- package/types/services/health.d.ts +5 -5
- package/types/services/manager.d.ts +49 -9
- package/types/services/migrations.d.ts +13 -13
- package/types/services/organization.d.ts +234 -0
- package/types/services/organizations.d.ts +5 -131
- package/types/services/presences.d.ts +166 -0
- package/types/services/project.d.ts +93 -86
- package/types/services/projects.d.ts +10 -159
- package/types/services/proxy.d.ts +5 -5
- package/types/services/realtime.d.ts +45 -3
- package/types/services/sites.d.ts +43 -32
- package/types/services/usage.d.ts +50 -0
- package/types/services/vectors-db.d.ts +6 -9
- package/types/enums/addon.d.ts +0 -3
- package/types/enums/build-runtime.d.ts +0 -91
- package/types/enums/frameworks.d.ts +0 -17
- package/types/enums/secure.d.ts +0 -4
- package/types/enums/status-code.d.ts +0 -6
- package/types/enums/status.d.ts +0 -3
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { Client } from '../client';
|
|
2
2
|
import type { Models } from '../models';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
3
|
+
import { DomainRegistrationType } from '../enums/domain-registration-type';
|
|
4
|
+
import { DomainSuggestionType } from '../enums/domain-suggestion-type';
|
|
5
5
|
export declare class Domains {
|
|
6
6
|
client: Client;
|
|
7
7
|
constructor(client: Client);
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
10
10
|
*
|
|
11
11
|
* @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
|
|
12
12
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
@@ -18,7 +18,7 @@ export declare class Domains {
|
|
|
18
18
|
search?: string;
|
|
19
19
|
}): Promise<Models.DomainsList>;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
22
22
|
*
|
|
23
23
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
|
|
24
24
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
@@ -28,7 +28,7 @@ export declare class Domains {
|
|
|
28
28
|
*/
|
|
29
29
|
list(queries?: string[], search?: string): Promise<Models.DomainsList>;
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
|
|
32
32
|
*
|
|
33
33
|
* @param {string} params.teamId - Team unique ID.
|
|
34
34
|
* @param {string} params.domain - Domain name (e.g. "example.com").
|
|
@@ -40,7 +40,7 @@ export declare class Domains {
|
|
|
40
40
|
domain: string;
|
|
41
41
|
}): Promise<Models.Domain>;
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
43
|
+
* Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.
|
|
44
44
|
*
|
|
45
45
|
* @param {string} teamId - Team unique ID.
|
|
46
46
|
* @param {string} domain - Domain name (e.g. "example.com").
|
|
@@ -50,32 +50,32 @@ export declare class Domains {
|
|
|
50
50
|
*/
|
|
51
51
|
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* Get the registration price for a domain name.
|
|
54
54
|
*
|
|
55
55
|
* @param {string} params.domain - Domain name to get price for.
|
|
56
56
|
* @param {number} params.periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
57
|
-
* @param {
|
|
57
|
+
* @param {DomainRegistrationType} params.registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
58
58
|
* @throws {AppwriteException}
|
|
59
59
|
* @returns {Promise<Models.DomainPrice>}
|
|
60
60
|
*/
|
|
61
61
|
getPrice(params: {
|
|
62
62
|
domain: string;
|
|
63
63
|
periodYears?: number;
|
|
64
|
-
registrationType?:
|
|
64
|
+
registrationType?: DomainRegistrationType;
|
|
65
65
|
}): Promise<Models.DomainPrice>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* Get the registration price for a domain name.
|
|
68
68
|
*
|
|
69
69
|
* @param {string} domain - Domain name to get price for.
|
|
70
70
|
* @param {number} periodYears - Number of years to calculate the domain price for. Must be at least 1.
|
|
71
|
-
* @param {
|
|
71
|
+
* @param {DomainRegistrationType} registrationType - Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.
|
|
72
72
|
* @throws {AppwriteException}
|
|
73
73
|
* @returns {Promise<Models.DomainPrice>}
|
|
74
74
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
75
75
|
*/
|
|
76
|
-
getPrice(domain: string, periodYears?: number, registrationType?:
|
|
76
|
+
getPrice(domain: string, periodYears?: number, registrationType?: DomainRegistrationType): Promise<Models.DomainPrice>;
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
78
|
+
* Initiate a domain purchase by providing registrant details and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Purchase endpoint to capture the payment and finalize the purchase.
|
|
79
79
|
*
|
|
80
80
|
* @param {string} params.domain - Fully qualified domain name to purchase (for example, example.com).
|
|
81
81
|
* @param {string} params.organizationId - Team ID that will own the domain.
|
|
@@ -107,7 +107,7 @@ export declare class Domains {
|
|
|
107
107
|
autoRenewal?: boolean;
|
|
108
108
|
}): Promise<Models.DomainPurchase>;
|
|
109
109
|
/**
|
|
110
|
-
*
|
|
110
|
+
* Initiate a domain purchase by providing registrant details and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Purchase endpoint to capture the payment and finalize the purchase.
|
|
111
111
|
*
|
|
112
112
|
* @param {string} domain - Fully qualified domain name to purchase (for example, example.com).
|
|
113
113
|
* @param {string} organizationId - Team ID that will own the domain.
|
|
@@ -127,7 +127,7 @@ export declare class Domains {
|
|
|
127
127
|
*/
|
|
128
128
|
createPurchase(domain: string, organizationId: string, firstName: string, lastName: string, email: string, phone: string, billingAddressId: string, paymentMethodId: string, addressLine3?: string, companyName?: string, periodYears?: number, autoRenewal?: boolean): Promise<Models.DomainPurchase>;
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
130
|
+
* Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
|
|
131
131
|
*
|
|
132
132
|
* @param {string} params.invoiceId - Invoice ID.
|
|
133
133
|
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
@@ -139,7 +139,7 @@ export declare class Domains {
|
|
|
139
139
|
organizationId: string;
|
|
140
140
|
}): Promise<Models.DomainPurchase>;
|
|
141
141
|
/**
|
|
142
|
-
*
|
|
142
|
+
* Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
|
|
143
143
|
*
|
|
144
144
|
* @param {string} invoiceId - Invoice ID.
|
|
145
145
|
* @param {string} organizationId - Team ID that owns the domain.
|
|
@@ -149,12 +149,12 @@ export declare class Domains {
|
|
|
149
149
|
*/
|
|
150
150
|
updatePurchase(invoiceId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
151
151
|
/**
|
|
152
|
-
*
|
|
152
|
+
* List domain suggestions.
|
|
153
153
|
*
|
|
154
154
|
* @param {string} params.query - Query to find available domains and suggestions. Max length: 256 chars.
|
|
155
155
|
* @param {string[]} params.tlds - TLDs to suggest.
|
|
156
156
|
* @param {number} params.limit - Maximum number of suggestions to return.
|
|
157
|
-
* @param {
|
|
157
|
+
* @param {DomainSuggestionType} params.filterType - Filter type: premium, suggestion.
|
|
158
158
|
* @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.
|
|
159
159
|
* @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.
|
|
160
160
|
* @throws {AppwriteException}
|
|
@@ -164,26 +164,26 @@ export declare class Domains {
|
|
|
164
164
|
query: string;
|
|
165
165
|
tlds?: string[];
|
|
166
166
|
limit?: number;
|
|
167
|
-
filterType?:
|
|
167
|
+
filterType?: DomainSuggestionType;
|
|
168
168
|
priceMax?: number;
|
|
169
169
|
priceMin?: number;
|
|
170
170
|
}): Promise<Models.DomainSuggestionsList>;
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
172
|
+
* List domain suggestions.
|
|
173
173
|
*
|
|
174
174
|
* @param {string} query - Query to find available domains and suggestions. Max length: 256 chars.
|
|
175
175
|
* @param {string[]} tlds - TLDs to suggest.
|
|
176
176
|
* @param {number} limit - Maximum number of suggestions to return.
|
|
177
|
-
* @param {
|
|
177
|
+
* @param {DomainSuggestionType} filterType - Filter type: premium, suggestion.
|
|
178
178
|
* @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.
|
|
179
179
|
* @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.
|
|
180
180
|
* @throws {AppwriteException}
|
|
181
181
|
* @returns {Promise<Models.DomainSuggestionsList>}
|
|
182
182
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
183
183
|
*/
|
|
184
|
-
listSuggestions(query: string, tlds?: string[], limit?: number, filterType?:
|
|
184
|
+
listSuggestions(query: string, tlds?: string[], limit?: number, filterType?: DomainSuggestionType, priceMax?: number, priceMin?: number): Promise<Models.DomainSuggestionsList>;
|
|
185
185
|
/**
|
|
186
|
-
*
|
|
186
|
+
* Initiate a domain transfer-in by providing an authorization code, registrant details, and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Transfer In endpoint to capture the payment and submit the transfer.
|
|
187
187
|
*
|
|
188
188
|
* @param {string} params.domain - Domain name to transfer in.
|
|
189
189
|
* @param {string} params.organizationId - Organization ID that this domain will belong to.
|
|
@@ -201,7 +201,7 @@ export declare class Domains {
|
|
|
201
201
|
autoRenewal?: boolean;
|
|
202
202
|
}): Promise<Models.DomainPurchase>;
|
|
203
203
|
/**
|
|
204
|
-
*
|
|
204
|
+
* Initiate a domain transfer-in by providing an authorization code, registrant details, and a payment method. Authorizes the payment and returns a `clientSecret`. If 3D Secure is required, use the `clientSecret` on the client to complete the authentication challenge. Once authentication is complete (or if none is needed), call the Update Transfer In endpoint to capture the payment and submit the transfer.
|
|
205
205
|
*
|
|
206
206
|
* @param {string} domain - Domain name to transfer in.
|
|
207
207
|
* @param {string} organizationId - Organization ID that this domain will belong to.
|
|
@@ -214,7 +214,7 @@ export declare class Domains {
|
|
|
214
214
|
*/
|
|
215
215
|
createTransferIn(domain: string, organizationId: string, authCode: string, paymentMethodId: string, autoRenewal?: boolean): Promise<Models.DomainPurchase>;
|
|
216
216
|
/**
|
|
217
|
-
*
|
|
217
|
+
* Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
|
|
218
218
|
*
|
|
219
219
|
* @param {string} params.invoiceId - Invoice ID.
|
|
220
220
|
* @param {string} params.organizationId - Team ID that owns the domain.
|
|
@@ -226,7 +226,7 @@ export declare class Domains {
|
|
|
226
226
|
organizationId: string;
|
|
227
227
|
}): Promise<Models.DomainPurchase>;
|
|
228
228
|
/**
|
|
229
|
-
*
|
|
229
|
+
* Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
|
|
230
230
|
*
|
|
231
231
|
* @param {string} invoiceId - Invoice ID.
|
|
232
232
|
* @param {string} organizationId - Team ID that owns the domain.
|
|
@@ -236,7 +236,7 @@ export declare class Domains {
|
|
|
236
236
|
*/
|
|
237
237
|
updateTransferIn(invoiceId: string, organizationId: string): Promise<Models.DomainPurchase>;
|
|
238
238
|
/**
|
|
239
|
-
*
|
|
239
|
+
* Initiate a domain transfer-out by generating an authorization code for the specified domain. The returned `authCode` should be provided to the gaining provider to complete the transfer. If the domain has auto-renewal enabled, it will be automatically disabled as part of this operation.
|
|
240
240
|
*
|
|
241
241
|
* @param {string} params.domainId - Domain unique ID.
|
|
242
242
|
* @param {string} params.organizationId - Organization ID that this domain belongs to.
|
|
@@ -248,7 +248,7 @@ export declare class Domains {
|
|
|
248
248
|
organizationId: string;
|
|
249
249
|
}): Promise<Models.DomainTransferOut>;
|
|
250
250
|
/**
|
|
251
|
-
*
|
|
251
|
+
* Initiate a domain transfer-out by generating an authorization code for the specified domain. The returned `authCode` should be provided to the gaining provider to complete the transfer. If the domain has auto-renewal enabled, it will be automatically disabled as part of this operation.
|
|
252
252
|
*
|
|
253
253
|
* @param {string} domainId - Domain unique ID.
|
|
254
254
|
* @param {string} organizationId - Organization ID that this domain belongs to.
|
|
@@ -258,7 +258,7 @@ export declare class Domains {
|
|
|
258
258
|
*/
|
|
259
259
|
createTransferOut(domainId: string, organizationId: string): Promise<Models.DomainTransferOut>;
|
|
260
260
|
/**
|
|
261
|
-
*
|
|
261
|
+
* Get a domain by its unique ID.
|
|
262
262
|
*
|
|
263
263
|
* @param {string} params.domainId - Domain unique ID.
|
|
264
264
|
* @throws {AppwriteException}
|
|
@@ -268,7 +268,7 @@ export declare class Domains {
|
|
|
268
268
|
domainId: string;
|
|
269
269
|
}): Promise<Models.Domain>;
|
|
270
270
|
/**
|
|
271
|
-
*
|
|
271
|
+
* Get a domain by its unique ID.
|
|
272
272
|
*
|
|
273
273
|
* @param {string} domainId - Domain unique ID.
|
|
274
274
|
* @throws {AppwriteException}
|
|
@@ -298,7 +298,7 @@ export declare class Domains {
|
|
|
298
298
|
*/
|
|
299
299
|
delete(domainId: string): Promise<{}>;
|
|
300
300
|
/**
|
|
301
|
-
*
|
|
301
|
+
* Enable or disable auto-renewal for a domain.
|
|
302
302
|
*
|
|
303
303
|
* @param {string} params.domainId - Domain unique ID.
|
|
304
304
|
* @param {boolean} params.autoRenewal - Whether the domain should renew automatically.
|
|
@@ -310,7 +310,7 @@ export declare class Domains {
|
|
|
310
310
|
autoRenewal: boolean;
|
|
311
311
|
}): Promise<Models.Domain>;
|
|
312
312
|
/**
|
|
313
|
-
*
|
|
313
|
+
* Enable or disable auto-renewal for a domain.
|
|
314
314
|
*
|
|
315
315
|
* @param {string} domainId - Domain unique ID.
|
|
316
316
|
* @param {boolean} autoRenewal - Whether the domain should renew automatically.
|
|
@@ -320,9 +320,9 @@ export declare class Domains {
|
|
|
320
320
|
*/
|
|
321
321
|
updateAutoRenewal(domainId: string, autoRenewal: boolean): Promise<Models.Domain>;
|
|
322
322
|
/**
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
323
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
324
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
325
|
+
* Appwrite nameservers.
|
|
326
326
|
*
|
|
327
327
|
* @param {string} params.domainId - Domain unique ID.
|
|
328
328
|
* @throws {AppwriteException}
|
|
@@ -332,9 +332,9 @@ export declare class Domains {
|
|
|
332
332
|
domainId: string;
|
|
333
333
|
}): Promise<Models.Domain>;
|
|
334
334
|
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
335
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
336
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
337
|
+
* Appwrite nameservers.
|
|
338
338
|
*
|
|
339
339
|
* @param {string} domainId - Domain unique ID.
|
|
340
340
|
* @throws {AppwriteException}
|
|
@@ -343,7 +343,7 @@ export declare class Domains {
|
|
|
343
343
|
*/
|
|
344
344
|
updateNameservers(domainId: string): Promise<Models.Domain>;
|
|
345
345
|
/**
|
|
346
|
-
*
|
|
346
|
+
* List Google Workspace DNS records.
|
|
347
347
|
*
|
|
348
348
|
* @param {string} params.domainId - Domain unique ID.
|
|
349
349
|
* @throws {AppwriteException}
|
|
@@ -353,7 +353,7 @@ export declare class Domains {
|
|
|
353
353
|
domainId: string;
|
|
354
354
|
}): Promise<Models.DnsRecordsList>;
|
|
355
355
|
/**
|
|
356
|
-
*
|
|
356
|
+
* List Google Workspace DNS records.
|
|
357
357
|
*
|
|
358
358
|
* @param {string} domainId - Domain unique ID.
|
|
359
359
|
* @throws {AppwriteException}
|
|
@@ -362,8 +362,8 @@ export declare class Domains {
|
|
|
362
362
|
*/
|
|
363
363
|
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
364
364
|
/**
|
|
365
|
-
*
|
|
366
|
-
*
|
|
365
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
366
|
+
* for Google Workspace email hosting.
|
|
367
367
|
*
|
|
368
368
|
* @param {string} params.domainId - Domain unique ID.
|
|
369
369
|
* @throws {AppwriteException}
|
|
@@ -373,8 +373,8 @@ export declare class Domains {
|
|
|
373
373
|
domainId: string;
|
|
374
374
|
}): Promise<Models.DnsRecordsList>;
|
|
375
375
|
/**
|
|
376
|
-
*
|
|
377
|
-
*
|
|
376
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
377
|
+
* for Google Workspace email hosting.
|
|
378
378
|
*
|
|
379
379
|
* @param {string} domainId - Domain unique ID.
|
|
380
380
|
* @throws {AppwriteException}
|
|
@@ -383,7 +383,7 @@ export declare class Domains {
|
|
|
383
383
|
*/
|
|
384
384
|
createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
385
385
|
/**
|
|
386
|
-
*
|
|
386
|
+
* List iCloud DNS records.
|
|
387
387
|
*
|
|
388
388
|
* @param {string} params.domainId - Domain unique ID.
|
|
389
389
|
* @throws {AppwriteException}
|
|
@@ -393,7 +393,7 @@ export declare class Domains {
|
|
|
393
393
|
domainId: string;
|
|
394
394
|
}): Promise<Models.DnsRecordsList>;
|
|
395
395
|
/**
|
|
396
|
-
*
|
|
396
|
+
* List iCloud DNS records.
|
|
397
397
|
*
|
|
398
398
|
* @param {string} domainId - Domain unique ID.
|
|
399
399
|
* @throws {AppwriteException}
|
|
@@ -402,8 +402,8 @@ export declare class Domains {
|
|
|
402
402
|
*/
|
|
403
403
|
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
404
404
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
405
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
406
|
+
* for using iCloud email services with your domain.
|
|
407
407
|
*
|
|
408
408
|
* @param {string} params.domainId - Domain unique ID.
|
|
409
409
|
* @throws {AppwriteException}
|
|
@@ -413,8 +413,8 @@ export declare class Domains {
|
|
|
413
413
|
domainId: string;
|
|
414
414
|
}): Promise<Models.DnsRecordsList>;
|
|
415
415
|
/**
|
|
416
|
-
*
|
|
417
|
-
*
|
|
416
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
417
|
+
* for using iCloud email services with your domain.
|
|
418
418
|
*
|
|
419
419
|
* @param {string} domainId - Domain unique ID.
|
|
420
420
|
* @throws {AppwriteException}
|
|
@@ -423,7 +423,7 @@ export declare class Domains {
|
|
|
423
423
|
*/
|
|
424
424
|
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
425
425
|
/**
|
|
426
|
-
*
|
|
426
|
+
* List Mailgun DNS records.
|
|
427
427
|
*
|
|
428
428
|
* @param {string} params.domainId - Domain unique ID.
|
|
429
429
|
* @throws {AppwriteException}
|
|
@@ -433,7 +433,7 @@ export declare class Domains {
|
|
|
433
433
|
domainId: string;
|
|
434
434
|
}): Promise<Models.DnsRecordsList>;
|
|
435
435
|
/**
|
|
436
|
-
*
|
|
436
|
+
* List Mailgun DNS records.
|
|
437
437
|
*
|
|
438
438
|
* @param {string} domainId - Domain unique ID.
|
|
439
439
|
* @throws {AppwriteException}
|
|
@@ -442,8 +442,8 @@ export declare class Domains {
|
|
|
442
442
|
*/
|
|
443
443
|
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
444
444
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
445
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
446
|
+
* for Mailgun in the specified domain.
|
|
447
447
|
*
|
|
448
448
|
* @param {string} params.domainId - Domain unique ID.
|
|
449
449
|
* @throws {AppwriteException}
|
|
@@ -453,8 +453,8 @@ export declare class Domains {
|
|
|
453
453
|
domainId: string;
|
|
454
454
|
}): Promise<Models.DnsRecordsList>;
|
|
455
455
|
/**
|
|
456
|
-
*
|
|
457
|
-
*
|
|
456
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
457
|
+
* for Mailgun in the specified domain.
|
|
458
458
|
*
|
|
459
459
|
* @param {string} domainId - Domain unique ID.
|
|
460
460
|
* @throws {AppwriteException}
|
|
@@ -463,7 +463,7 @@ export declare class Domains {
|
|
|
463
463
|
*/
|
|
464
464
|
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
465
465
|
/**
|
|
466
|
-
*
|
|
466
|
+
* List Outlook DNS records.
|
|
467
467
|
*
|
|
468
468
|
* @param {string} params.domainId - Domain unique ID.
|
|
469
469
|
* @throws {AppwriteException}
|
|
@@ -473,7 +473,7 @@ export declare class Domains {
|
|
|
473
473
|
domainId: string;
|
|
474
474
|
}): Promise<Models.DnsRecordsList>;
|
|
475
475
|
/**
|
|
476
|
-
*
|
|
476
|
+
* List Outlook DNS records.
|
|
477
477
|
*
|
|
478
478
|
* @param {string} domainId - Domain unique ID.
|
|
479
479
|
* @throws {AppwriteException}
|
|
@@ -482,8 +482,8 @@ export declare class Domains {
|
|
|
482
482
|
*/
|
|
483
483
|
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
484
484
|
/**
|
|
485
|
-
*
|
|
486
|
-
*
|
|
485
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
486
|
+
* for setting up Outlook email hosting for your domain.
|
|
487
487
|
*
|
|
488
488
|
* @param {string} params.domainId - Domain unique ID.
|
|
489
489
|
* @throws {AppwriteException}
|
|
@@ -493,8 +493,8 @@ export declare class Domains {
|
|
|
493
493
|
domainId: string;
|
|
494
494
|
}): Promise<Models.DnsRecordsList>;
|
|
495
495
|
/**
|
|
496
|
-
*
|
|
497
|
-
*
|
|
496
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
497
|
+
* for setting up Outlook email hosting for your domain.
|
|
498
498
|
*
|
|
499
499
|
* @param {string} domainId - Domain unique ID.
|
|
500
500
|
* @throws {AppwriteException}
|
|
@@ -503,7 +503,7 @@ export declare class Domains {
|
|
|
503
503
|
*/
|
|
504
504
|
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
505
505
|
/**
|
|
506
|
-
*
|
|
506
|
+
* List ProtonMail DNS records.
|
|
507
507
|
*
|
|
508
508
|
* @param {string} params.domainId - Domain unique ID.
|
|
509
509
|
* @throws {AppwriteException}
|
|
@@ -513,7 +513,7 @@ export declare class Domains {
|
|
|
513
513
|
domainId: string;
|
|
514
514
|
}): Promise<Models.DnsRecordsList>;
|
|
515
515
|
/**
|
|
516
|
-
*
|
|
516
|
+
* List ProtonMail DNS records.
|
|
517
517
|
*
|
|
518
518
|
* @param {string} domainId - Domain unique ID.
|
|
519
519
|
* @throws {AppwriteException}
|
|
@@ -522,8 +522,8 @@ export declare class Domains {
|
|
|
522
522
|
*/
|
|
523
523
|
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
524
524
|
/**
|
|
525
|
-
*
|
|
526
|
-
*
|
|
525
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
526
|
+
* for using ProtonMail with your custom domain.
|
|
527
527
|
*
|
|
528
528
|
* @param {string} params.domainId - Domain unique ID.
|
|
529
529
|
* @throws {AppwriteException}
|
|
@@ -533,8 +533,8 @@ export declare class Domains {
|
|
|
533
533
|
domainId: string;
|
|
534
534
|
}): Promise<Models.DnsRecordsList>;
|
|
535
535
|
/**
|
|
536
|
-
*
|
|
537
|
-
*
|
|
536
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
537
|
+
* for using ProtonMail with your custom domain.
|
|
538
538
|
*
|
|
539
539
|
* @param {string} domainId - Domain unique ID.
|
|
540
540
|
* @throws {AppwriteException}
|
|
@@ -543,7 +543,7 @@ export declare class Domains {
|
|
|
543
543
|
*/
|
|
544
544
|
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
545
545
|
/**
|
|
546
|
-
*
|
|
546
|
+
* List Zoho DNS records.
|
|
547
547
|
*
|
|
548
548
|
* @param {string} params.domainId - Domain unique ID.
|
|
549
549
|
* @throws {AppwriteException}
|
|
@@ -553,7 +553,7 @@ export declare class Domains {
|
|
|
553
553
|
domainId: string;
|
|
554
554
|
}): Promise<Models.DnsRecordsList>;
|
|
555
555
|
/**
|
|
556
|
-
*
|
|
556
|
+
* List Zoho DNS records.
|
|
557
557
|
*
|
|
558
558
|
* @param {string} domainId - Domain unique ID.
|
|
559
559
|
* @throws {AppwriteException}
|
|
@@ -562,8 +562,8 @@ export declare class Domains {
|
|
|
562
562
|
*/
|
|
563
563
|
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
564
564
|
/**
|
|
565
|
-
*
|
|
566
|
-
*
|
|
565
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
566
|
+
* for setting up Zoho Mail on your domain.
|
|
567
567
|
*
|
|
568
568
|
* @param {string} params.domainId - Domain unique ID.
|
|
569
569
|
* @throws {AppwriteException}
|
|
@@ -573,8 +573,8 @@ export declare class Domains {
|
|
|
573
573
|
domainId: string;
|
|
574
574
|
}): Promise<Models.DnsRecordsList>;
|
|
575
575
|
/**
|
|
576
|
-
*
|
|
577
|
-
*
|
|
576
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
577
|
+
* for setting up Zoho Mail on your domain.
|
|
578
578
|
*
|
|
579
579
|
* @param {string} domainId - Domain unique ID.
|
|
580
580
|
* @throws {AppwriteException}
|
|
@@ -583,8 +583,8 @@ export declare class Domains {
|
|
|
583
583
|
*/
|
|
584
584
|
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
585
585
|
/**
|
|
586
|
-
*
|
|
587
|
-
*
|
|
586
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
587
|
+
* associated with your domain.
|
|
588
588
|
*
|
|
589
589
|
* @param {string} params.domainId - Domain unique ID.
|
|
590
590
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -596,8 +596,8 @@ export declare class Domains {
|
|
|
596
596
|
queries?: string[];
|
|
597
597
|
}): Promise<Models.DnsRecordsList>;
|
|
598
598
|
/**
|
|
599
|
-
*
|
|
600
|
-
*
|
|
599
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
600
|
+
* associated with your domain.
|
|
601
601
|
*
|
|
602
602
|
* @param {string} domainId - Domain unique ID.
|
|
603
603
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -640,9 +640,9 @@ export declare class Domains {
|
|
|
640
640
|
*/
|
|
641
641
|
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
642
642
|
/**
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
643
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
644
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
645
|
+
* and optional comment.
|
|
646
646
|
*
|
|
647
647
|
* @param {string} params.domainId - Domain unique ID.
|
|
648
648
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -662,9 +662,9 @@ export declare class Domains {
|
|
|
662
662
|
comment?: string;
|
|
663
663
|
}): Promise<Models.DnsRecord>;
|
|
664
664
|
/**
|
|
665
|
-
*
|
|
666
|
-
*
|
|
667
|
-
*
|
|
665
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
666
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
667
|
+
* and optional comment.
|
|
668
668
|
*
|
|
669
669
|
* @param {string} domainId - Domain unique ID.
|
|
670
670
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -678,8 +678,8 @@ export declare class Domains {
|
|
|
678
678
|
*/
|
|
679
679
|
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
680
680
|
/**
|
|
681
|
-
*
|
|
682
|
-
*
|
|
681
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
682
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
683
683
|
*
|
|
684
684
|
* @param {string} params.domainId - Domain unique ID.
|
|
685
685
|
* @param {string} params.name - Record name (subdomain).
|
|
@@ -697,8 +697,8 @@ export declare class Domains {
|
|
|
697
697
|
comment?: string;
|
|
698
698
|
}): Promise<Models.DnsRecord>;
|
|
699
699
|
/**
|
|
700
|
-
*
|
|
701
|
-
*
|
|
700
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
701
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
702
702
|
*
|
|
703
703
|
* @param {string} domainId - Domain unique ID.
|
|
704
704
|
* @param {string} name - Record name (subdomain).
|
|
@@ -711,9 +711,9 @@ export declare class Domains {
|
|
|
711
711
|
*/
|
|
712
712
|
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
713
713
|
/**
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
*
|
|
714
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
715
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
716
|
+
* TTL, and optional comment.
|
|
717
717
|
*
|
|
718
718
|
* @param {string} params.domainId - Domain unique ID.
|
|
719
719
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -733,9 +733,9 @@ export declare class Domains {
|
|
|
733
733
|
comment?: string;
|
|
734
734
|
}): Promise<Models.DnsRecord>;
|
|
735
735
|
/**
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
736
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
737
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
738
|
+
* TTL, and optional comment.
|
|
739
739
|
*
|
|
740
740
|
* @param {string} domainId - Domain unique ID.
|
|
741
741
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -749,9 +749,9 @@ export declare class Domains {
|
|
|
749
749
|
*/
|
|
750
750
|
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
751
751
|
/**
|
|
752
|
-
*
|
|
753
|
-
*
|
|
754
|
-
*
|
|
752
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
753
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
754
|
+
* map your domain to a target domain that may change its IP address.
|
|
755
755
|
*
|
|
756
756
|
* @param {string} params.domainId - Domain unique ID.
|
|
757
757
|
* @param {string} params.name - Record name.
|
|
@@ -769,9 +769,9 @@ export declare class Domains {
|
|
|
769
769
|
comment?: string;
|
|
770
770
|
}): Promise<Models.DnsRecord>;
|
|
771
771
|
/**
|
|
772
|
-
*
|
|
773
|
-
*
|
|
774
|
-
*
|
|
772
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
773
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
774
|
+
* map your domain to a target domain that may change its IP address.
|
|
775
775
|
*
|
|
776
776
|
* @param {string} domainId - Domain unique ID.
|
|
777
777
|
* @param {string} name - Record name.
|
|
@@ -784,11 +784,11 @@ export declare class Domains {
|
|
|
784
784
|
*/
|
|
785
785
|
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
786
786
|
/**
|
|
787
|
-
*
|
|
788
|
-
*
|
|
787
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
788
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
789
789
|
*
|
|
790
|
-
*
|
|
791
|
-
*
|
|
790
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
791
|
+
* It provides a way to map one domain name to another.
|
|
792
792
|
*
|
|
793
793
|
* @param {string} params.domainId - Domain unique ID.
|
|
794
794
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -808,11 +808,11 @@ export declare class Domains {
|
|
|
808
808
|
comment?: string;
|
|
809
809
|
}): Promise<Models.DnsRecord>;
|
|
810
810
|
/**
|
|
811
|
-
*
|
|
812
|
-
*
|
|
811
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
812
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
813
813
|
*
|
|
814
|
-
*
|
|
815
|
-
*
|
|
814
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
815
|
+
* It provides a way to map one domain name to another.
|
|
816
816
|
*
|
|
817
817
|
* @param {string} domainId - Domain unique ID.
|
|
818
818
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -859,9 +859,9 @@ export declare class Domains {
|
|
|
859
859
|
*/
|
|
860
860
|
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
861
861
|
/**
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
*
|
|
862
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
863
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
864
|
+
* for a domain.
|
|
865
865
|
*
|
|
866
866
|
* @param {string} params.domainId - Domain unique ID.
|
|
867
867
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -881,9 +881,9 @@ export declare class Domains {
|
|
|
881
881
|
comment?: string;
|
|
882
882
|
}): Promise<Models.DnsRecord>;
|
|
883
883
|
/**
|
|
884
|
-
*
|
|
885
|
-
*
|
|
886
|
-
*
|
|
884
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
885
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
886
|
+
* for a domain.
|
|
887
887
|
*
|
|
888
888
|
* @param {string} domainId - Domain unique ID.
|
|
889
889
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -897,11 +897,11 @@ export declare class Domains {
|
|
|
897
897
|
*/
|
|
898
898
|
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
899
899
|
/**
|
|
900
|
-
*
|
|
900
|
+
* Create a new CNAME record for the given domain.
|
|
901
901
|
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
902
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
903
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
904
|
+
* to 'example.wordpress.com'.
|
|
905
905
|
*
|
|
906
906
|
* @param {string} params.domainId - Domain unique ID.
|
|
907
907
|
* @param {string} params.name - Record name (subdomain).
|
|
@@ -919,11 +919,11 @@ export declare class Domains {
|
|
|
919
919
|
comment?: string;
|
|
920
920
|
}): Promise<Models.DnsRecord>;
|
|
921
921
|
/**
|
|
922
|
-
*
|
|
922
|
+
* Create a new CNAME record for the given domain.
|
|
923
923
|
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
924
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
925
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
926
|
+
* to 'example.wordpress.com'.
|
|
927
927
|
*
|
|
928
928
|
* @param {string} domainId - Domain unique ID.
|
|
929
929
|
* @param {string} name - Record name (subdomain).
|
|
@@ -936,7 +936,7 @@ export declare class Domains {
|
|
|
936
936
|
*/
|
|
937
937
|
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
938
938
|
/**
|
|
939
|
-
*
|
|
939
|
+
* Update an existing CNAME record for the given domain.
|
|
940
940
|
*
|
|
941
941
|
* @param {string} params.domainId - Domain unique ID.
|
|
942
942
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -956,7 +956,7 @@ export declare class Domains {
|
|
|
956
956
|
comment?: string;
|
|
957
957
|
}): Promise<Models.DnsRecord>;
|
|
958
958
|
/**
|
|
959
|
-
*
|
|
959
|
+
* Update an existing CNAME record for the given domain.
|
|
960
960
|
*
|
|
961
961
|
* @param {string} domainId - Domain unique ID.
|
|
962
962
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -970,8 +970,8 @@ export declare class Domains {
|
|
|
970
970
|
*/
|
|
971
971
|
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
972
972
|
/**
|
|
973
|
-
*
|
|
974
|
-
*
|
|
973
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
974
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
975
975
|
*
|
|
976
976
|
* @param {string} params.domainId - Domain unique ID.
|
|
977
977
|
* @param {string} params.name - Record name (subdomain).
|
|
@@ -989,8 +989,8 @@ export declare class Domains {
|
|
|
989
989
|
comment?: string;
|
|
990
990
|
}): Promise<Models.DnsRecord>;
|
|
991
991
|
/**
|
|
992
|
-
*
|
|
993
|
-
*
|
|
992
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
993
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
994
994
|
*
|
|
995
995
|
* @param {string} domainId - Domain unique ID.
|
|
996
996
|
* @param {string} name - Record name (subdomain).
|
|
@@ -1041,10 +1041,10 @@ export declare class Domains {
|
|
|
1041
1041
|
*/
|
|
1042
1042
|
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1043
1043
|
/**
|
|
1044
|
-
*
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1044
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
1045
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
1046
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
1047
|
+
* higher priority.
|
|
1048
1048
|
*
|
|
1049
1049
|
* @param {string} params.domainId - Domain unique ID.
|
|
1050
1050
|
* @param {string} params.name - Record name (subdomain).
|
|
@@ -1064,10 +1064,10 @@ export declare class Domains {
|
|
|
1064
1064
|
comment?: string;
|
|
1065
1065
|
}): Promise<Models.DnsRecord>;
|
|
1066
1066
|
/**
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1067
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
1068
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
1069
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
1070
|
+
* higher priority.
|
|
1071
1071
|
*
|
|
1072
1072
|
* @param {string} domainId - Domain unique ID.
|
|
1073
1073
|
* @param {string} name - Record name (subdomain).
|
|
@@ -1081,7 +1081,7 @@ export declare class Domains {
|
|
|
1081
1081
|
*/
|
|
1082
1082
|
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1083
1083
|
/**
|
|
1084
|
-
*
|
|
1084
|
+
* Update an existing MX record for the given domain.
|
|
1085
1085
|
*
|
|
1086
1086
|
* @param {string} params.domainId - Domain unique ID.
|
|
1087
1087
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1103,7 +1103,7 @@ export declare class Domains {
|
|
|
1103
1103
|
comment?: string;
|
|
1104
1104
|
}): Promise<Models.DnsRecord>;
|
|
1105
1105
|
/**
|
|
1106
|
-
*
|
|
1106
|
+
* Update an existing MX record for the given domain.
|
|
1107
1107
|
*
|
|
1108
1108
|
* @param {string} domainId - Domain unique ID.
|
|
1109
1109
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1118,8 +1118,8 @@ export declare class Domains {
|
|
|
1118
1118
|
*/
|
|
1119
1119
|
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1120
1120
|
/**
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1121
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
1122
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
1123
1123
|
*
|
|
1124
1124
|
* @param {string} params.domainId - Domain unique ID.
|
|
1125
1125
|
* @param {string} params.name - Record name (subdomain).
|
|
@@ -1137,8 +1137,8 @@ export declare class Domains {
|
|
|
1137
1137
|
comment?: string;
|
|
1138
1138
|
}): Promise<Models.DnsRecord>;
|
|
1139
1139
|
/**
|
|
1140
|
-
*
|
|
1141
|
-
*
|
|
1140
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
1141
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
1142
1142
|
*
|
|
1143
1143
|
* @param {string} domainId - Domain unique ID.
|
|
1144
1144
|
* @param {string} name - Record name (subdomain).
|
|
@@ -1151,10 +1151,10 @@ export declare class Domains {
|
|
|
1151
1151
|
*/
|
|
1152
1152
|
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1153
1153
|
/**
|
|
1154
|
-
*
|
|
1155
|
-
*
|
|
1156
|
-
*
|
|
1157
|
-
*
|
|
1154
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
1155
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
1156
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
1157
|
+
* for better record management.
|
|
1158
1158
|
*
|
|
1159
1159
|
* @param {string} params.domainId - Domain unique ID.
|
|
1160
1160
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1174,10 +1174,10 @@ export declare class Domains {
|
|
|
1174
1174
|
comment?: string;
|
|
1175
1175
|
}): Promise<Models.DnsRecord>;
|
|
1176
1176
|
/**
|
|
1177
|
-
*
|
|
1178
|
-
*
|
|
1179
|
-
*
|
|
1180
|
-
*
|
|
1177
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
1178
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
1179
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
1180
|
+
* for better record management.
|
|
1181
1181
|
*
|
|
1182
1182
|
* @param {string} domainId - Domain unique ID.
|
|
1183
1183
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1191,9 +1191,9 @@ export declare class Domains {
|
|
|
1191
1191
|
*/
|
|
1192
1192
|
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1193
1193
|
/**
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1194
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
1195
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
1196
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
1197
1197
|
*
|
|
1198
1198
|
* @param {string} params.domainId - Domain unique ID.
|
|
1199
1199
|
* @param {string} params.name - Record name (service name).
|
|
@@ -1217,9 +1217,9 @@ export declare class Domains {
|
|
|
1217
1217
|
comment?: string;
|
|
1218
1218
|
}): Promise<Models.DnsRecord>;
|
|
1219
1219
|
/**
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1222
|
-
*
|
|
1220
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
1221
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
1222
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
1223
1223
|
*
|
|
1224
1224
|
* @param {string} domainId - Domain unique ID.
|
|
1225
1225
|
* @param {string} name - Record name (service name).
|
|
@@ -1235,20 +1235,20 @@ export declare class Domains {
|
|
|
1235
1235
|
*/
|
|
1236
1236
|
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1237
1237
|
/**
|
|
1238
|
-
*
|
|
1238
|
+
* Update an existing SRV record for the given domain.
|
|
1239
1239
|
*
|
|
1240
|
-
*
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1247
|
-
*
|
|
1248
|
-
*
|
|
1240
|
+
* Required parameters:
|
|
1241
|
+
* - domainId: Domain unique ID
|
|
1242
|
+
* - recordId: DNS record unique ID
|
|
1243
|
+
* - name: Record name (service name)
|
|
1244
|
+
* - value: Target hostname for this SRV record
|
|
1245
|
+
* - ttl: Time to live, in seconds
|
|
1246
|
+
* - priority: Record priority
|
|
1247
|
+
* - weight: Record weight
|
|
1248
|
+
* - port: Port number for the service
|
|
1249
1249
|
*
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1250
|
+
* Optional parameters:
|
|
1251
|
+
* - comment: A comment for this record
|
|
1252
1252
|
*
|
|
1253
1253
|
* @param {string} params.domainId - Domain unique ID.
|
|
1254
1254
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1274,20 +1274,20 @@ export declare class Domains {
|
|
|
1274
1274
|
comment?: string;
|
|
1275
1275
|
}): Promise<Models.DnsRecord>;
|
|
1276
1276
|
/**
|
|
1277
|
-
*
|
|
1277
|
+
* Update an existing SRV record for the given domain.
|
|
1278
1278
|
*
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
*
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1279
|
+
* Required parameters:
|
|
1280
|
+
* - domainId: Domain unique ID
|
|
1281
|
+
* - recordId: DNS record unique ID
|
|
1282
|
+
* - name: Record name (service name)
|
|
1283
|
+
* - value: Target hostname for this SRV record
|
|
1284
|
+
* - ttl: Time to live, in seconds
|
|
1285
|
+
* - priority: Record priority
|
|
1286
|
+
* - weight: Record weight
|
|
1287
|
+
* - port: Port number for the service
|
|
1288
1288
|
*
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1289
|
+
* Optional parameters:
|
|
1290
|
+
* - comment: A comment for this record
|
|
1291
1291
|
*
|
|
1292
1292
|
* @param {string} domainId - Domain unique ID.
|
|
1293
1293
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1304,9 +1304,9 @@ export declare class Domains {
|
|
|
1304
1304
|
*/
|
|
1305
1305
|
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1306
1306
|
/**
|
|
1307
|
-
*
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1307
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
1308
|
+
* to provide additional information about your domain, such as domain
|
|
1309
|
+
* verification records, SPF records, or DKIM records.
|
|
1310
1310
|
*
|
|
1311
1311
|
* @param {string} params.domainId - Domain unique ID.
|
|
1312
1312
|
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
@@ -1324,9 +1324,9 @@ export declare class Domains {
|
|
|
1324
1324
|
comment?: string;
|
|
1325
1325
|
}): Promise<Models.DnsRecord>;
|
|
1326
1326
|
/**
|
|
1327
|
-
*
|
|
1328
|
-
*
|
|
1329
|
-
*
|
|
1327
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
1328
|
+
* to provide additional information about your domain, such as domain
|
|
1329
|
+
* verification records, SPF records, or DKIM records.
|
|
1330
1330
|
*
|
|
1331
1331
|
* @param {string} domainId - Domain unique ID.
|
|
1332
1332
|
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
@@ -1339,10 +1339,10 @@ export declare class Domains {
|
|
|
1339
1339
|
*/
|
|
1340
1340
|
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
|
|
1341
1341
|
/**
|
|
1342
|
-
*
|
|
1342
|
+
* Update an existing TXT record for the given domain.
|
|
1343
1343
|
*
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1344
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1345
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1346
1346
|
*
|
|
1347
1347
|
* @param {string} params.domainId - Domain unique ID.
|
|
1348
1348
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1362,10 +1362,10 @@ export declare class Domains {
|
|
|
1362
1362
|
comment?: string;
|
|
1363
1363
|
}): Promise<Models.DnsRecord>;
|
|
1364
1364
|
/**
|
|
1365
|
-
*
|
|
1365
|
+
* Update an existing TXT record for the given domain.
|
|
1366
1366
|
*
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1367
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1368
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1369
1369
|
*
|
|
1370
1370
|
* @param {string} domainId - Domain unique ID.
|
|
1371
1371
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1379,11 +1379,11 @@ export declare class Domains {
|
|
|
1379
1379
|
*/
|
|
1380
1380
|
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1381
1381
|
/**
|
|
1382
|
-
*
|
|
1382
|
+
* Get a single DNS record for a given domain by record ID.
|
|
1383
1383
|
*
|
|
1384
|
-
*
|
|
1385
|
-
*
|
|
1386
|
-
*
|
|
1384
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
1385
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
1386
|
+
* such as type, value, and TTL settings.
|
|
1387
1387
|
*
|
|
1388
1388
|
* @param {string} params.domainId - Domain unique ID.
|
|
1389
1389
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1395,11 +1395,11 @@ export declare class Domains {
|
|
|
1395
1395
|
recordId: string;
|
|
1396
1396
|
}): Promise<Models.DnsRecord>;
|
|
1397
1397
|
/**
|
|
1398
|
-
*
|
|
1398
|
+
* Get a single DNS record for a given domain by record ID.
|
|
1399
1399
|
*
|
|
1400
|
-
*
|
|
1401
|
-
*
|
|
1402
|
-
*
|
|
1400
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
1401
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
1402
|
+
* such as type, value, and TTL settings.
|
|
1403
1403
|
*
|
|
1404
1404
|
* @param {string} domainId - Domain unique ID.
|
|
1405
1405
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1409,8 +1409,8 @@ export declare class Domains {
|
|
|
1409
1409
|
*/
|
|
1410
1410
|
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
|
|
1411
1411
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
*
|
|
1412
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1413
|
+
* from a specific domain.
|
|
1414
1414
|
*
|
|
1415
1415
|
* @param {string} params.domainId - Domain unique ID.
|
|
1416
1416
|
* @param {string} params.recordId - DNS record unique ID.
|
|
@@ -1422,8 +1422,8 @@ export declare class Domains {
|
|
|
1422
1422
|
recordId: string;
|
|
1423
1423
|
}): Promise<{}>;
|
|
1424
1424
|
/**
|
|
1425
|
-
*
|
|
1426
|
-
*
|
|
1425
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1426
|
+
* from a specific domain.
|
|
1427
1427
|
*
|
|
1428
1428
|
* @param {string} domainId - Domain unique ID.
|
|
1429
1429
|
* @param {string} recordId - DNS record unique ID.
|
|
@@ -1433,10 +1433,10 @@ export declare class Domains {
|
|
|
1433
1433
|
*/
|
|
1434
1434
|
deleteRecord(domainId: string, recordId: string): Promise<{}>;
|
|
1435
1435
|
/**
|
|
1436
|
-
*
|
|
1436
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1437
1437
|
*
|
|
1438
|
-
*
|
|
1439
|
-
*
|
|
1438
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
1439
|
+
* and all its DNS records to the new team.
|
|
1440
1440
|
*
|
|
1441
1441
|
* @param {string} params.domainId - Domain unique ID.
|
|
1442
1442
|
* @param {string} params.teamId - New team unique ID.
|
|
@@ -1448,10 +1448,10 @@ export declare class Domains {
|
|
|
1448
1448
|
teamId: string;
|
|
1449
1449
|
}): Promise<Models.Domain>;
|
|
1450
1450
|
/**
|
|
1451
|
-
*
|
|
1451
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1452
1452
|
*
|
|
1453
|
-
*
|
|
1454
|
-
*
|
|
1453
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
1454
|
+
* and all its DNS records to the new team.
|
|
1455
1455
|
*
|
|
1456
1456
|
* @param {string} domainId - Domain unique ID.
|
|
1457
1457
|
* @param {string} teamId - New team unique ID.
|
|
@@ -1461,7 +1461,7 @@ export declare class Domains {
|
|
|
1461
1461
|
*/
|
|
1462
1462
|
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
1463
1463
|
/**
|
|
1464
|
-
*
|
|
1464
|
+
* Retrieve the current transfer status for a domain. Returns the status, an optional reason, and a timestamp of the last status change.
|
|
1465
1465
|
*
|
|
1466
1466
|
* @param {string} params.domainId - Domain unique ID.
|
|
1467
1467
|
* @throws {AppwriteException}
|
|
@@ -1471,7 +1471,7 @@ export declare class Domains {
|
|
|
1471
1471
|
domainId: string;
|
|
1472
1472
|
}): Promise<Models.DomainTransferStatus>;
|
|
1473
1473
|
/**
|
|
1474
|
-
*
|
|
1474
|
+
* Retrieve the current transfer status for a domain. Returns the status, an optional reason, and a timestamp of the last status change.
|
|
1475
1475
|
*
|
|
1476
1476
|
* @param {string} domainId - Domain unique ID.
|
|
1477
1477
|
* @throws {AppwriteException}
|
|
@@ -1480,8 +1480,8 @@ export declare class Domains {
|
|
|
1480
1480
|
*/
|
|
1481
1481
|
getTransferStatus(domainId: string): Promise<Models.DomainTransferStatus>;
|
|
1482
1482
|
/**
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1483
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1484
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1485
1485
|
*
|
|
1486
1486
|
* @param {string} params.domainId - Domain unique ID.
|
|
1487
1487
|
* @throws {AppwriteException}
|
|
@@ -1491,8 +1491,8 @@ export declare class Domains {
|
|
|
1491
1491
|
domainId: string;
|
|
1492
1492
|
}): Promise<{}>;
|
|
1493
1493
|
/**
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1494
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1495
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1496
1496
|
*
|
|
1497
1497
|
* @param {string} domainId - Domain unique ID.
|
|
1498
1498
|
* @throws {AppwriteException}
|