appbuild-oceanbase-console 1.10.2
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/LICENSE +12 -0
- package/README.md +191 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +27712 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +27675 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +27716 -0
- package/package.json +47 -0
- package/types/client.d.ts +211 -0
- package/types/enums/adapter.d.ts +4 -0
- package/types/enums/api-service.d.ts +15 -0
- package/types/enums/api.d.ts +5 -0
- package/types/enums/attribute-status.d.ts +7 -0
- package/types/enums/auth-method.d.ts +9 -0
- package/types/enums/authentication-factor.d.ts +6 -0
- package/types/enums/authenticator-type.d.ts +3 -0
- package/types/enums/billing-plan.d.ts +10 -0
- package/types/enums/browser.d.ts +16 -0
- package/types/enums/build-runtime.d.ts +66 -0
- package/types/enums/column-status.d.ts +7 -0
- package/types/enums/compression.d.ts +5 -0
- package/types/enums/console-resource-type.d.ts +3 -0
- package/types/enums/credit-card.d.ts +19 -0
- package/types/enums/database-type.d.ts +4 -0
- package/types/enums/deployment-download-type.d.ts +4 -0
- package/types/enums/deployment-status.d.ts +7 -0
- package/types/enums/email-template-locale.d.ts +133 -0
- package/types/enums/email-template-type.d.ts +9 -0
- package/types/enums/execution-method.d.ts +9 -0
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/flag.d.ts +197 -0
- package/types/enums/framework.d.ts +17 -0
- package/types/enums/health-antivirus-status.d.ts +5 -0
- package/types/enums/health-check-status.d.ts +4 -0
- package/types/enums/image-format.d.ts +9 -0
- package/types/enums/image-gravity.d.ts +11 -0
- package/types/enums/index-status.d.ts +7 -0
- package/types/enums/index-type.d.ts +6 -0
- package/types/enums/message-priority.d.ts +4 -0
- package/types/enums/message-status.d.ts +7 -0
- package/types/enums/messaging-provider-type.d.ts +5 -0
- package/types/enums/name.d.ts +14 -0
- package/types/enums/o-auth-provider.d.ts +43 -0
- package/types/enums/output.d.ts +9 -0
- package/types/enums/password-hash.d.ts +13 -0
- package/types/enums/platform-type.d.ts +17 -0
- package/types/enums/platform.d.ts +4 -0
- package/types/enums/project-usage-range.d.ts +4 -0
- package/types/enums/proxy-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
- package/types/enums/proxy-rule-status.d.ts +6 -0
- package/types/enums/region.d.ts +8 -0
- package/types/enums/relation-mutate.d.ts +5 -0
- package/types/enums/relationship-type.d.ts +6 -0
- package/types/enums/runtime.d.ts +66 -0
- package/types/enums/sms-template-locale.d.ts +133 -0
- package/types/enums/sms-template-type.d.ts +6 -0
- package/types/enums/smtp-encryption.d.ts +5 -0
- package/types/enums/smtp-secure.d.ts +4 -0
- package/types/enums/status-code.d.ts +6 -0
- package/types/enums/status.d.ts +4 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +421 -0
- package/types/enums/type.d.ts +5 -0
- package/types/enums/usage-range.d.ts +5 -0
- package/types/enums/vcs-deployment-type.d.ts +5 -0
- package/types/enums/vcs-detection-type.d.ts +4 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +102 -0
- package/types/migrations.d.ts +240 -0
- package/types/models.d.ts +7945 -0
- package/types/operator.d.ts +180 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +390 -0
- package/types/role.d.ts +70 -0
- package/types/sdk.d.ts +108 -0
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +1413 -0
- package/types/services/assistant.d.ts +24 -0
- package/types/services/avatars.d.ts +319 -0
- package/types/services/backups.d.ts +276 -0
- package/types/services/console.d.ts +210 -0
- package/types/services/databases.d.ts +2119 -0
- package/types/services/domains.d.ts +1276 -0
- package/types/services/functions.d.ts +827 -0
- package/types/services/graphql.d.ts +43 -0
- package/types/services/health.d.ts +432 -0
- package/types/services/locale.d.ts +64 -0
- package/types/services/messaging.d.ts +1989 -0
- package/types/services/migrations.d.ts +413 -0
- package/types/services/organizations.d.ts +842 -0
- package/types/services/project.d.ts +130 -0
- package/types/services/projects.d.ts +1663 -0
- package/types/services/proxy.d.ts +190 -0
- package/types/services/realtime.d.ts +118 -0
- package/types/services/sites.d.ts +780 -0
- package/types/services/storage.d.ts +467 -0
- package/types/services/tables-db.d.ts +2034 -0
- package/types/services/teams.d.ts +366 -0
- package/types/services/tokens.d.ts +119 -0
- package/types/services/users.d.ts +1184 -0
- package/types/services/vcs.d.ts +249 -0
|
@@ -0,0 +1,1276 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
export declare class Domains {
|
|
4
|
+
client: Client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
8
|
+
*
|
|
9
|
+
* @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.
|
|
10
|
+
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
11
|
+
* @throws {AppwriteException}
|
|
12
|
+
* @returns {Promise<Models.DomainsList>}
|
|
13
|
+
*/
|
|
14
|
+
list(params?: {
|
|
15
|
+
queries?: string[];
|
|
16
|
+
search?: string;
|
|
17
|
+
}): Promise<Models.DomainsList>;
|
|
18
|
+
/**
|
|
19
|
+
* List all domains registered for this project. This endpoint supports pagination.
|
|
20
|
+
*
|
|
21
|
+
* @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.
|
|
22
|
+
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
23
|
+
* @throws {AppwriteException}
|
|
24
|
+
* @returns {Promise<Models.DomainsList>}
|
|
25
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
26
|
+
*/
|
|
27
|
+
list(queries?: string[], search?: string): Promise<Models.DomainsList>;
|
|
28
|
+
/**
|
|
29
|
+
* 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.
|
|
30
|
+
*
|
|
31
|
+
* @param {string} params.teamId - Team unique ID.
|
|
32
|
+
* @param {string} params.domain - Domain name (e.g. "example.com").
|
|
33
|
+
* @throws {AppwriteException}
|
|
34
|
+
* @returns {Promise<Models.Domain>}
|
|
35
|
+
*/
|
|
36
|
+
create(params: {
|
|
37
|
+
teamId: string;
|
|
38
|
+
domain: string;
|
|
39
|
+
}): Promise<Models.Domain>;
|
|
40
|
+
/**
|
|
41
|
+
* 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.
|
|
42
|
+
*
|
|
43
|
+
* @param {string} teamId - Team unique ID.
|
|
44
|
+
* @param {string} domain - Domain name (e.g. "example.com").
|
|
45
|
+
* @throws {AppwriteException}
|
|
46
|
+
* @returns {Promise<Models.Domain>}
|
|
47
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
48
|
+
*/
|
|
49
|
+
create(teamId: string, domain: string): Promise<Models.Domain>;
|
|
50
|
+
/**
|
|
51
|
+
* Get a domain by its unique ID.
|
|
52
|
+
*
|
|
53
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
54
|
+
* @throws {AppwriteException}
|
|
55
|
+
* @returns {Promise<Models.Domain>}
|
|
56
|
+
*/
|
|
57
|
+
get(params: {
|
|
58
|
+
domainId: string;
|
|
59
|
+
}): Promise<Models.Domain>;
|
|
60
|
+
/**
|
|
61
|
+
* Get a domain by its unique ID.
|
|
62
|
+
*
|
|
63
|
+
* @param {string} domainId - Domain unique ID.
|
|
64
|
+
* @throws {AppwriteException}
|
|
65
|
+
* @returns {Promise<Models.Domain>}
|
|
66
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
67
|
+
*/
|
|
68
|
+
get(domainId: string): Promise<Models.Domain>;
|
|
69
|
+
/**
|
|
70
|
+
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
71
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
72
|
+
*
|
|
73
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
74
|
+
* @throws {AppwriteException}
|
|
75
|
+
* @returns {Promise<{}>}
|
|
76
|
+
*/
|
|
77
|
+
delete(params: {
|
|
78
|
+
domainId: string;
|
|
79
|
+
}): Promise<{}>;
|
|
80
|
+
/**
|
|
81
|
+
* Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.
|
|
82
|
+
* Once deleted, the domain will no longer be available for use and all associated resources will be removed.
|
|
83
|
+
*
|
|
84
|
+
* @param {string} domainId - Domain unique ID.
|
|
85
|
+
* @throws {AppwriteException}
|
|
86
|
+
* @returns {Promise<{}>}
|
|
87
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
88
|
+
*/
|
|
89
|
+
delete(domainId: string): Promise<{}>;
|
|
90
|
+
/**
|
|
91
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
92
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
93
|
+
* Appwrite nameservers.
|
|
94
|
+
*
|
|
95
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
96
|
+
* @throws {AppwriteException}
|
|
97
|
+
* @returns {Promise<Models.Domain>}
|
|
98
|
+
*/
|
|
99
|
+
updateNameservers(params: {
|
|
100
|
+
domainId: string;
|
|
101
|
+
}): Promise<Models.Domain>;
|
|
102
|
+
/**
|
|
103
|
+
* Verify which NS records are used and update the domain accordingly. This will check the domain's
|
|
104
|
+
* nameservers and update the domain's status based on whether the nameservers match the expected
|
|
105
|
+
* Appwrite nameservers.
|
|
106
|
+
*
|
|
107
|
+
* @param {string} domainId - Domain unique ID.
|
|
108
|
+
* @throws {AppwriteException}
|
|
109
|
+
* @returns {Promise<Models.Domain>}
|
|
110
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
111
|
+
*/
|
|
112
|
+
updateNameservers(domainId: string): Promise<Models.Domain>;
|
|
113
|
+
/**
|
|
114
|
+
* List Google Workspace DNS records.
|
|
115
|
+
*
|
|
116
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
117
|
+
* @throws {AppwriteException}
|
|
118
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
119
|
+
*/
|
|
120
|
+
getPresetGoogleWorkspace(params: {
|
|
121
|
+
domainId: string;
|
|
122
|
+
}): Promise<Models.DnsRecordsList>;
|
|
123
|
+
/**
|
|
124
|
+
* List Google Workspace DNS records.
|
|
125
|
+
*
|
|
126
|
+
* @param {string} domainId - Domain unique ID.
|
|
127
|
+
* @throws {AppwriteException}
|
|
128
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
129
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
130
|
+
*/
|
|
131
|
+
getPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
132
|
+
/**
|
|
133
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
134
|
+
* for Google Workspace email hosting.
|
|
135
|
+
*
|
|
136
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
137
|
+
* @throws {AppwriteException}
|
|
138
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
139
|
+
*/
|
|
140
|
+
createPresetGoogleWorkspace(params: {
|
|
141
|
+
domainId: string;
|
|
142
|
+
}): Promise<Models.DnsRecordsList>;
|
|
143
|
+
/**
|
|
144
|
+
* Add Google Workspace DNS records to the domain. This will create the required MX records
|
|
145
|
+
* for Google Workspace email hosting.
|
|
146
|
+
*
|
|
147
|
+
* @param {string} domainId - Domain unique ID.
|
|
148
|
+
* @throws {AppwriteException}
|
|
149
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
150
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
151
|
+
*/
|
|
152
|
+
createPresetGoogleWorkspace(domainId: string): Promise<Models.DnsRecordsList>;
|
|
153
|
+
/**
|
|
154
|
+
* List iCloud DNS records.
|
|
155
|
+
*
|
|
156
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
157
|
+
* @throws {AppwriteException}
|
|
158
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
159
|
+
*/
|
|
160
|
+
getPresetICloud(params: {
|
|
161
|
+
domainId: string;
|
|
162
|
+
}): Promise<Models.DnsRecordsList>;
|
|
163
|
+
/**
|
|
164
|
+
* List iCloud DNS records.
|
|
165
|
+
*
|
|
166
|
+
* @param {string} domainId - Domain unique ID.
|
|
167
|
+
* @throws {AppwriteException}
|
|
168
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
169
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
170
|
+
*/
|
|
171
|
+
getPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
172
|
+
/**
|
|
173
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
174
|
+
* for using iCloud email services with your domain.
|
|
175
|
+
*
|
|
176
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
177
|
+
* @throws {AppwriteException}
|
|
178
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
179
|
+
*/
|
|
180
|
+
createPresetICloud(params: {
|
|
181
|
+
domainId: string;
|
|
182
|
+
}): Promise<Models.DnsRecordsList>;
|
|
183
|
+
/**
|
|
184
|
+
* Add iCloud DNS records to the domain. This will create the required MX and SPF records
|
|
185
|
+
* for using iCloud email services with your domain.
|
|
186
|
+
*
|
|
187
|
+
* @param {string} domainId - Domain unique ID.
|
|
188
|
+
* @throws {AppwriteException}
|
|
189
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
190
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
191
|
+
*/
|
|
192
|
+
createPresetICloud(domainId: string): Promise<Models.DnsRecordsList>;
|
|
193
|
+
/**
|
|
194
|
+
* List Mailgun DNS records.
|
|
195
|
+
*
|
|
196
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
197
|
+
* @throws {AppwriteException}
|
|
198
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
199
|
+
*/
|
|
200
|
+
getPresetMailgun(params: {
|
|
201
|
+
domainId: string;
|
|
202
|
+
}): Promise<Models.DnsRecordsList>;
|
|
203
|
+
/**
|
|
204
|
+
* List Mailgun DNS records.
|
|
205
|
+
*
|
|
206
|
+
* @param {string} domainId - Domain unique ID.
|
|
207
|
+
* @throws {AppwriteException}
|
|
208
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
209
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
210
|
+
*/
|
|
211
|
+
getPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
212
|
+
/**
|
|
213
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
214
|
+
* for Mailgun in the specified domain.
|
|
215
|
+
*
|
|
216
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
217
|
+
* @throws {AppwriteException}
|
|
218
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
219
|
+
*/
|
|
220
|
+
createPresetMailgun(params: {
|
|
221
|
+
domainId: string;
|
|
222
|
+
}): Promise<Models.DnsRecordsList>;
|
|
223
|
+
/**
|
|
224
|
+
* Add Mailgun DNS records to the domain. This endpoint will create the required DNS records
|
|
225
|
+
* for Mailgun in the specified domain.
|
|
226
|
+
*
|
|
227
|
+
* @param {string} domainId - Domain unique ID.
|
|
228
|
+
* @throws {AppwriteException}
|
|
229
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
230
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
231
|
+
*/
|
|
232
|
+
createPresetMailgun(domainId: string): Promise<Models.DnsRecordsList>;
|
|
233
|
+
/**
|
|
234
|
+
* List Outlook DNS records.
|
|
235
|
+
*
|
|
236
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
237
|
+
* @throws {AppwriteException}
|
|
238
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
239
|
+
*/
|
|
240
|
+
getPresetOutlook(params: {
|
|
241
|
+
domainId: string;
|
|
242
|
+
}): Promise<Models.DnsRecordsList>;
|
|
243
|
+
/**
|
|
244
|
+
* List Outlook DNS records.
|
|
245
|
+
*
|
|
246
|
+
* @param {string} domainId - Domain unique ID.
|
|
247
|
+
* @throws {AppwriteException}
|
|
248
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
250
|
+
*/
|
|
251
|
+
getPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
252
|
+
/**
|
|
253
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
254
|
+
* for setting up Outlook email hosting for your domain.
|
|
255
|
+
*
|
|
256
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
257
|
+
* @throws {AppwriteException}
|
|
258
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
259
|
+
*/
|
|
260
|
+
createPresetOutlook(params: {
|
|
261
|
+
domainId: string;
|
|
262
|
+
}): Promise<Models.DnsRecordsList>;
|
|
263
|
+
/**
|
|
264
|
+
* Add Outlook DNS records to the domain. This will create the required MX records
|
|
265
|
+
* for setting up Outlook email hosting for your domain.
|
|
266
|
+
*
|
|
267
|
+
* @param {string} domainId - Domain unique ID.
|
|
268
|
+
* @throws {AppwriteException}
|
|
269
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
270
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
271
|
+
*/
|
|
272
|
+
createPresetOutlook(domainId: string): Promise<Models.DnsRecordsList>;
|
|
273
|
+
/**
|
|
274
|
+
* List ProtonMail DNS records.
|
|
275
|
+
*
|
|
276
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
277
|
+
* @throws {AppwriteException}
|
|
278
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
279
|
+
*/
|
|
280
|
+
getPresetProtonMail(params: {
|
|
281
|
+
domainId: string;
|
|
282
|
+
}): Promise<Models.DnsRecordsList>;
|
|
283
|
+
/**
|
|
284
|
+
* List ProtonMail DNS records.
|
|
285
|
+
*
|
|
286
|
+
* @param {string} domainId - Domain unique ID.
|
|
287
|
+
* @throws {AppwriteException}
|
|
288
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
289
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
290
|
+
*/
|
|
291
|
+
getPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
292
|
+
/**
|
|
293
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
294
|
+
* for using ProtonMail with your custom domain.
|
|
295
|
+
*
|
|
296
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
297
|
+
* @throws {AppwriteException}
|
|
298
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
299
|
+
*/
|
|
300
|
+
createPresetProtonMail(params: {
|
|
301
|
+
domainId: string;
|
|
302
|
+
}): Promise<Models.DnsRecordsList>;
|
|
303
|
+
/**
|
|
304
|
+
* Add ProtonMail DNS records to the domain. This will create the required MX records
|
|
305
|
+
* for using ProtonMail with your custom domain.
|
|
306
|
+
*
|
|
307
|
+
* @param {string} domainId - Domain unique ID.
|
|
308
|
+
* @throws {AppwriteException}
|
|
309
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
310
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
311
|
+
*/
|
|
312
|
+
createPresetProtonMail(domainId: string): Promise<Models.DnsRecordsList>;
|
|
313
|
+
/**
|
|
314
|
+
* List Zoho DNS records.
|
|
315
|
+
*
|
|
316
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
317
|
+
* @throws {AppwriteException}
|
|
318
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
319
|
+
*/
|
|
320
|
+
getPresetZoho(params: {
|
|
321
|
+
domainId: string;
|
|
322
|
+
}): Promise<Models.DnsRecordsList>;
|
|
323
|
+
/**
|
|
324
|
+
* List Zoho DNS records.
|
|
325
|
+
*
|
|
326
|
+
* @param {string} domainId - Domain unique ID.
|
|
327
|
+
* @throws {AppwriteException}
|
|
328
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
329
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
330
|
+
*/
|
|
331
|
+
getPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
332
|
+
/**
|
|
333
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
334
|
+
* for setting up Zoho Mail on your domain.
|
|
335
|
+
*
|
|
336
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
337
|
+
* @throws {AppwriteException}
|
|
338
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
339
|
+
*/
|
|
340
|
+
createPresetZoho(params: {
|
|
341
|
+
domainId: string;
|
|
342
|
+
}): Promise<Models.DnsRecordsList>;
|
|
343
|
+
/**
|
|
344
|
+
* Add Zoho Mail DNS records to the domain. This will create the required MX records
|
|
345
|
+
* for setting up Zoho Mail on your domain.
|
|
346
|
+
*
|
|
347
|
+
* @param {string} domainId - Domain unique ID.
|
|
348
|
+
* @throws {AppwriteException}
|
|
349
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
350
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
351
|
+
*/
|
|
352
|
+
createPresetZoho(domainId: string): Promise<Models.DnsRecordsList>;
|
|
353
|
+
/**
|
|
354
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
355
|
+
* associated with your domain.
|
|
356
|
+
*
|
|
357
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
358
|
+
* @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.
|
|
359
|
+
* @throws {AppwriteException}
|
|
360
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
361
|
+
*/
|
|
362
|
+
listRecords(params: {
|
|
363
|
+
domainId: string;
|
|
364
|
+
queries?: string[];
|
|
365
|
+
}): Promise<Models.DnsRecordsList>;
|
|
366
|
+
/**
|
|
367
|
+
* List DNS records for a given domain. You can use this endpoint to list all the DNS records
|
|
368
|
+
* associated with your domain.
|
|
369
|
+
*
|
|
370
|
+
* @param {string} domainId - Domain unique ID.
|
|
371
|
+
* @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.
|
|
372
|
+
* @throws {AppwriteException}
|
|
373
|
+
* @returns {Promise<Models.DnsRecordsList>}
|
|
374
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
375
|
+
*/
|
|
376
|
+
listRecords(domainId: string, queries?: string[]): Promise<Models.DnsRecordsList>;
|
|
377
|
+
/**
|
|
378
|
+
* Create a new A record for the given domain. A records are used to point a domain name
|
|
379
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
380
|
+
*
|
|
381
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
382
|
+
* @param {string} params.name - Record name (subdomain).
|
|
383
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
384
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
385
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
386
|
+
* @throws {AppwriteException}
|
|
387
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
388
|
+
*/
|
|
389
|
+
createRecordA(params: {
|
|
390
|
+
domainId: string;
|
|
391
|
+
name: string;
|
|
392
|
+
value: string;
|
|
393
|
+
ttl: number;
|
|
394
|
+
comment?: string;
|
|
395
|
+
}): Promise<Models.DnsRecord>;
|
|
396
|
+
/**
|
|
397
|
+
* Create a new A record for the given domain. A records are used to point a domain name
|
|
398
|
+
* to an IPv4 address. The record value should be a valid IPv4 address.
|
|
399
|
+
*
|
|
400
|
+
* @param {string} domainId - Domain unique ID.
|
|
401
|
+
* @param {string} name - Record name (subdomain).
|
|
402
|
+
* @param {string} value - IPv4 address for this A record.
|
|
403
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
404
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
405
|
+
* @throws {AppwriteException}
|
|
406
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
407
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
408
|
+
*/
|
|
409
|
+
createRecordA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
410
|
+
/**
|
|
411
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
412
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
413
|
+
* and optional comment.
|
|
414
|
+
*
|
|
415
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
416
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
417
|
+
* @param {string} params.name - Record name (subdomain).
|
|
418
|
+
* @param {string} params.value - IPv4 address for this A record.
|
|
419
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
420
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
421
|
+
* @throws {AppwriteException}
|
|
422
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
423
|
+
*/
|
|
424
|
+
updateRecordA(params: {
|
|
425
|
+
domainId: string;
|
|
426
|
+
recordId: string;
|
|
427
|
+
name: string;
|
|
428
|
+
value: string;
|
|
429
|
+
ttl: number;
|
|
430
|
+
comment?: string;
|
|
431
|
+
}): Promise<Models.DnsRecord>;
|
|
432
|
+
/**
|
|
433
|
+
* Update an existing A record for the given domain. This endpoint allows you to modify
|
|
434
|
+
* the properties of an A record including its name (subdomain), IPv4 address, TTL,
|
|
435
|
+
* and optional comment.
|
|
436
|
+
*
|
|
437
|
+
* @param {string} domainId - Domain unique ID.
|
|
438
|
+
* @param {string} recordId - DNS record unique ID.
|
|
439
|
+
* @param {string} name - Record name (subdomain).
|
|
440
|
+
* @param {string} value - IPv4 address for this A record.
|
|
441
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
442
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
443
|
+
* @throws {AppwriteException}
|
|
444
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
445
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
446
|
+
*/
|
|
447
|
+
updateRecordA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
448
|
+
/**
|
|
449
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
450
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
451
|
+
*
|
|
452
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
453
|
+
* @param {string} params.name - Record name (subdomain).
|
|
454
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
455
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
456
|
+
* @param {string} params.comment - A comment explaining what this record is for.
|
|
457
|
+
* @throws {AppwriteException}
|
|
458
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
459
|
+
*/
|
|
460
|
+
createRecordAAAA(params: {
|
|
461
|
+
domainId: string;
|
|
462
|
+
name: string;
|
|
463
|
+
value: string;
|
|
464
|
+
ttl: number;
|
|
465
|
+
comment?: string;
|
|
466
|
+
}): Promise<Models.DnsRecord>;
|
|
467
|
+
/**
|
|
468
|
+
* Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record
|
|
469
|
+
* to your domain. The record will be used to point a hostname to an IPv6 address.
|
|
470
|
+
*
|
|
471
|
+
* @param {string} domainId - Domain unique ID.
|
|
472
|
+
* @param {string} name - Record name (subdomain).
|
|
473
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
474
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
475
|
+
* @param {string} comment - A comment explaining what this record is for.
|
|
476
|
+
* @throws {AppwriteException}
|
|
477
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
478
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
479
|
+
*/
|
|
480
|
+
createRecordAAAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
481
|
+
/**
|
|
482
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
483
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
484
|
+
* TTL, and optional comment.
|
|
485
|
+
*
|
|
486
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
487
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
488
|
+
* @param {string} params.name - Record name (subdomain).
|
|
489
|
+
* @param {string} params.value - IPv6 address for this AAAA record.
|
|
490
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
491
|
+
* @param {string} params.comment - A comment for this record.
|
|
492
|
+
* @throws {AppwriteException}
|
|
493
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
494
|
+
*/
|
|
495
|
+
updateRecordAAAA(params: {
|
|
496
|
+
domainId: string;
|
|
497
|
+
recordId: string;
|
|
498
|
+
name: string;
|
|
499
|
+
value: string;
|
|
500
|
+
ttl: number;
|
|
501
|
+
comment?: string;
|
|
502
|
+
}): Promise<Models.DnsRecord>;
|
|
503
|
+
/**
|
|
504
|
+
* Update an existing AAAA record for the given domain. This endpoint allows you to modify
|
|
505
|
+
* the properties of an existing AAAA record, including its name (subdomain), IPv6 address,
|
|
506
|
+
* TTL, and optional comment.
|
|
507
|
+
*
|
|
508
|
+
* @param {string} domainId - Domain unique ID.
|
|
509
|
+
* @param {string} recordId - DNS record unique ID.
|
|
510
|
+
* @param {string} name - Record name (subdomain).
|
|
511
|
+
* @param {string} value - IPv6 address for this AAAA record.
|
|
512
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
513
|
+
* @param {string} comment - A comment for this record.
|
|
514
|
+
* @throws {AppwriteException}
|
|
515
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
516
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
517
|
+
*/
|
|
518
|
+
updateRecordAAAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
519
|
+
/**
|
|
520
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
521
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
522
|
+
* map your domain to a target domain that may change its IP address.
|
|
523
|
+
*
|
|
524
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
525
|
+
* @param {string} params.name - Record name.
|
|
526
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
527
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
528
|
+
* @param {string} params.comment - A comment for this record.
|
|
529
|
+
* @throws {AppwriteException}
|
|
530
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
531
|
+
*/
|
|
532
|
+
createRecordAlias(params: {
|
|
533
|
+
domainId: string;
|
|
534
|
+
name: string;
|
|
535
|
+
value: string;
|
|
536
|
+
ttl: number;
|
|
537
|
+
comment?: string;
|
|
538
|
+
}): Promise<Models.DnsRecord>;
|
|
539
|
+
/**
|
|
540
|
+
* Create a new ALIAS record for the given domain. This record type can be used to point your domain
|
|
541
|
+
* to another domain name that will serve as an alias. This is particularly useful when you want to
|
|
542
|
+
* map your domain to a target domain that may change its IP address.
|
|
543
|
+
*
|
|
544
|
+
* @param {string} domainId - Domain unique ID.
|
|
545
|
+
* @param {string} name - Record name.
|
|
546
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
547
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
548
|
+
* @param {string} comment - A comment for this record.
|
|
549
|
+
* @throws {AppwriteException}
|
|
550
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
551
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
552
|
+
*/
|
|
553
|
+
createRecordAlias(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
554
|
+
/**
|
|
555
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
556
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
557
|
+
*
|
|
558
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
559
|
+
* It provides a way to map one domain name to another.
|
|
560
|
+
*
|
|
561
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
562
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
563
|
+
* @param {string} params.name - Record name.
|
|
564
|
+
* @param {string} params.value - Target domain for this ALIAS record.
|
|
565
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
566
|
+
* @param {string} params.comment - A comment for this record.
|
|
567
|
+
* @throws {AppwriteException}
|
|
568
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
569
|
+
*/
|
|
570
|
+
updateRecordAlias(params: {
|
|
571
|
+
domainId: string;
|
|
572
|
+
recordId: string;
|
|
573
|
+
name: string;
|
|
574
|
+
value: string;
|
|
575
|
+
ttl: number;
|
|
576
|
+
comment?: string;
|
|
577
|
+
}): Promise<Models.DnsRecord>;
|
|
578
|
+
/**
|
|
579
|
+
* Update an existing ALIAS record for the specified domain. This endpoint allows you to modify
|
|
580
|
+
* the properties of an existing ALIAS record including its name, target domain, TTL, and comment.
|
|
581
|
+
*
|
|
582
|
+
* The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).
|
|
583
|
+
* It provides a way to map one domain name to another.
|
|
584
|
+
*
|
|
585
|
+
* @param {string} domainId - Domain unique ID.
|
|
586
|
+
* @param {string} recordId - DNS record unique ID.
|
|
587
|
+
* @param {string} name - Record name.
|
|
588
|
+
* @param {string} value - Target domain for this ALIAS record.
|
|
589
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
590
|
+
* @param {string} comment - A comment for this record.
|
|
591
|
+
* @throws {AppwriteException}
|
|
592
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
593
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
594
|
+
*/
|
|
595
|
+
updateRecordAlias(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
596
|
+
/**
|
|
597
|
+
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
598
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
599
|
+
*
|
|
600
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
601
|
+
* @param {string} params.name - Record name.
|
|
602
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
603
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
604
|
+
* @param {string} params.comment - A comment for this record.
|
|
605
|
+
* @throws {AppwriteException}
|
|
606
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
607
|
+
*/
|
|
608
|
+
createRecordCAA(params: {
|
|
609
|
+
domainId: string;
|
|
610
|
+
name: string;
|
|
611
|
+
value: string;
|
|
612
|
+
ttl: number;
|
|
613
|
+
comment?: string;
|
|
614
|
+
}): Promise<Models.DnsRecord>;
|
|
615
|
+
/**
|
|
616
|
+
* Create a new CAA record for the given domain. CAA records are used to specify which
|
|
617
|
+
* Certificate Authorities (CAs) are allowed to issue SSL/TLS certificates for your domain.
|
|
618
|
+
*
|
|
619
|
+
* @param {string} domainId - Domain unique ID.
|
|
620
|
+
* @param {string} name - Record name.
|
|
621
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
622
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
623
|
+
* @param {string} comment - A comment for this record.
|
|
624
|
+
* @throws {AppwriteException}
|
|
625
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
626
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
627
|
+
*/
|
|
628
|
+
createRecordCAA(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
629
|
+
/**
|
|
630
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
631
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
632
|
+
* for a domain.
|
|
633
|
+
*
|
|
634
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
635
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
636
|
+
* @param {string} params.name - Record name.
|
|
637
|
+
* @param {string} params.value - CAA value (e.g. issuer domain).
|
|
638
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
639
|
+
* @param {string} params.comment - A comment for this record.
|
|
640
|
+
* @throws {AppwriteException}
|
|
641
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
642
|
+
*/
|
|
643
|
+
updateRecordCAA(params: {
|
|
644
|
+
domainId: string;
|
|
645
|
+
recordId: string;
|
|
646
|
+
name: string;
|
|
647
|
+
value: string;
|
|
648
|
+
ttl: number;
|
|
649
|
+
comment?: string;
|
|
650
|
+
}): Promise<Models.DnsRecord>;
|
|
651
|
+
/**
|
|
652
|
+
* Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization)
|
|
653
|
+
* record is used to specify which certificate authorities (CAs) are authorized to issue certificates
|
|
654
|
+
* for a domain.
|
|
655
|
+
*
|
|
656
|
+
* @param {string} domainId - Domain unique ID.
|
|
657
|
+
* @param {string} recordId - DNS record unique ID.
|
|
658
|
+
* @param {string} name - Record name.
|
|
659
|
+
* @param {string} value - CAA value (e.g. issuer domain).
|
|
660
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
661
|
+
* @param {string} comment - A comment for this record.
|
|
662
|
+
* @throws {AppwriteException}
|
|
663
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
664
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
665
|
+
*/
|
|
666
|
+
updateRecordCAA(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
667
|
+
/**
|
|
668
|
+
* Create a new CNAME record for the given domain.
|
|
669
|
+
*
|
|
670
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
671
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
672
|
+
* to 'example.wordpress.com'.
|
|
673
|
+
*
|
|
674
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
675
|
+
* @param {string} params.name - Record name (subdomain).
|
|
676
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
677
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
678
|
+
* @param {string} params.comment - A comment for this record.
|
|
679
|
+
* @throws {AppwriteException}
|
|
680
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
681
|
+
*/
|
|
682
|
+
createRecordCNAME(params: {
|
|
683
|
+
domainId: string;
|
|
684
|
+
name: string;
|
|
685
|
+
value: string;
|
|
686
|
+
ttl: number;
|
|
687
|
+
comment?: string;
|
|
688
|
+
}): Promise<Models.DnsRecord>;
|
|
689
|
+
/**
|
|
690
|
+
* Create a new CNAME record for the given domain.
|
|
691
|
+
*
|
|
692
|
+
* A CNAME record maps a subdomain to another domain name, allowing you to create aliases
|
|
693
|
+
* for your domain. For example, you can create a CNAME record to point 'blog.example.com'
|
|
694
|
+
* to 'example.wordpress.com'.
|
|
695
|
+
*
|
|
696
|
+
* @param {string} domainId - Domain unique ID.
|
|
697
|
+
* @param {string} name - Record name (subdomain).
|
|
698
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
699
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
700
|
+
* @param {string} comment - A comment for this record.
|
|
701
|
+
* @throws {AppwriteException}
|
|
702
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
703
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
704
|
+
*/
|
|
705
|
+
createRecordCNAME(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
706
|
+
/**
|
|
707
|
+
* Update an existing CNAME record for the given domain.
|
|
708
|
+
*
|
|
709
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
710
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
711
|
+
* @param {string} params.name - Record name (subdomain).
|
|
712
|
+
* @param {string} params.value - Canonical target for this CNAME record.
|
|
713
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
714
|
+
* @param {string} params.comment - A comment for this record.
|
|
715
|
+
* @throws {AppwriteException}
|
|
716
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
717
|
+
*/
|
|
718
|
+
updateRecordCNAME(params: {
|
|
719
|
+
domainId: string;
|
|
720
|
+
recordId: string;
|
|
721
|
+
name: string;
|
|
722
|
+
value: string;
|
|
723
|
+
ttl: number;
|
|
724
|
+
comment?: string;
|
|
725
|
+
}): Promise<Models.DnsRecord>;
|
|
726
|
+
/**
|
|
727
|
+
* Update an existing CNAME record for the given domain.
|
|
728
|
+
*
|
|
729
|
+
* @param {string} domainId - Domain unique ID.
|
|
730
|
+
* @param {string} recordId - DNS record unique ID.
|
|
731
|
+
* @param {string} name - Record name (subdomain).
|
|
732
|
+
* @param {string} value - Canonical target for this CNAME record.
|
|
733
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
734
|
+
* @param {string} comment - A comment for this record.
|
|
735
|
+
* @throws {AppwriteException}
|
|
736
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
737
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
738
|
+
*/
|
|
739
|
+
updateRecordCNAME(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
740
|
+
/**
|
|
741
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
742
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
743
|
+
*
|
|
744
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
745
|
+
* @param {string} params.name - Record name (subdomain).
|
|
746
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
747
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
748
|
+
* @param {string} params.comment - A comment for this record.
|
|
749
|
+
* @throws {AppwriteException}
|
|
750
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
751
|
+
*/
|
|
752
|
+
createRecordHTTPS(params: {
|
|
753
|
+
domainId: string;
|
|
754
|
+
name: string;
|
|
755
|
+
value: string;
|
|
756
|
+
ttl: number;
|
|
757
|
+
comment?: string;
|
|
758
|
+
}): Promise<Models.DnsRecord>;
|
|
759
|
+
/**
|
|
760
|
+
* Create a new HTTPS record for the given domain. This record is used to configure HTTPS
|
|
761
|
+
* settings for your domain, enabling secure communication over SSL/TLS.
|
|
762
|
+
*
|
|
763
|
+
* @param {string} domainId - Domain unique ID.
|
|
764
|
+
* @param {string} name - Record name (subdomain).
|
|
765
|
+
* @param {string} value - Target for the HTTPS record.
|
|
766
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
767
|
+
* @param {string} comment - A comment for this record.
|
|
768
|
+
* @throws {AppwriteException}
|
|
769
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
770
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
771
|
+
*/
|
|
772
|
+
createRecordHTTPS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
773
|
+
/**
|
|
774
|
+
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
775
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
776
|
+
* target value, TTL, and optional comment.
|
|
777
|
+
*
|
|
778
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
779
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
780
|
+
* @param {string} params.name - Record name (subdomain).
|
|
781
|
+
* @param {string} params.value - Target for the HTTPS record.
|
|
782
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
783
|
+
* @param {string} params.comment - A comment for this record.
|
|
784
|
+
* @throws {AppwriteException}
|
|
785
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
786
|
+
*/
|
|
787
|
+
updateRecordHTTPS(params: {
|
|
788
|
+
domainId: string;
|
|
789
|
+
recordId: string;
|
|
790
|
+
name: string;
|
|
791
|
+
value: string;
|
|
792
|
+
ttl: number;
|
|
793
|
+
comment?: string;
|
|
794
|
+
}): Promise<Models.DnsRecord>;
|
|
795
|
+
/**
|
|
796
|
+
* Update an existing HTTPS record for the given domain. This endpoint allows you to modify
|
|
797
|
+
* the properties of an HTTPS record associated with your domain, including the name (subdomain),
|
|
798
|
+
* target value, TTL, and optional comment.
|
|
799
|
+
*
|
|
800
|
+
* @param {string} domainId - Domain unique ID.
|
|
801
|
+
* @param {string} recordId - DNS record unique ID.
|
|
802
|
+
* @param {string} name - Record name (subdomain).
|
|
803
|
+
* @param {string} value - Target for the HTTPS record.
|
|
804
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
805
|
+
* @param {string} comment - A comment for this record.
|
|
806
|
+
* @throws {AppwriteException}
|
|
807
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
808
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
809
|
+
*/
|
|
810
|
+
updateRecordHTTPS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
811
|
+
/**
|
|
812
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
813
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
814
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
815
|
+
* higher priority.
|
|
816
|
+
*
|
|
817
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
818
|
+
* @param {string} params.name - Record name (subdomain).
|
|
819
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
820
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
821
|
+
* @param {number} params.priority - MX priority.
|
|
822
|
+
* @param {string} params.comment - A comment for this record.
|
|
823
|
+
* @throws {AppwriteException}
|
|
824
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
825
|
+
*/
|
|
826
|
+
createRecordMX(params: {
|
|
827
|
+
domainId: string;
|
|
828
|
+
name: string;
|
|
829
|
+
value: string;
|
|
830
|
+
ttl: number;
|
|
831
|
+
priority: number;
|
|
832
|
+
comment?: string;
|
|
833
|
+
}): Promise<Models.DnsRecord>;
|
|
834
|
+
/**
|
|
835
|
+
* Create a new MX record for the given domain. MX records are used to define the mail servers responsible
|
|
836
|
+
* for accepting email messages for the domain. Multiple MX records can be created with different priorities.
|
|
837
|
+
* The priority parameter determines the order in which mail servers are used, with lower values indicating
|
|
838
|
+
* higher priority.
|
|
839
|
+
*
|
|
840
|
+
* @param {string} domainId - Domain unique ID.
|
|
841
|
+
* @param {string} name - Record name (subdomain).
|
|
842
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
843
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
844
|
+
* @param {number} priority - MX priority.
|
|
845
|
+
* @param {string} comment - A comment for this record.
|
|
846
|
+
* @throws {AppwriteException}
|
|
847
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
848
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
849
|
+
*/
|
|
850
|
+
createRecordMX(domainId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
851
|
+
/**
|
|
852
|
+
* Update an existing MX record for the given domain.
|
|
853
|
+
*
|
|
854
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
855
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
856
|
+
* @param {string} params.name - Record name (subdomain).
|
|
857
|
+
* @param {string} params.value - Mail server domain for this MX record.
|
|
858
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
859
|
+
* @param {number} params.priority - MX priority.
|
|
860
|
+
* @param {string} params.comment - A comment for this record.
|
|
861
|
+
* @throws {AppwriteException}
|
|
862
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
863
|
+
*/
|
|
864
|
+
updateRecordMX(params: {
|
|
865
|
+
domainId: string;
|
|
866
|
+
recordId: string;
|
|
867
|
+
name: string;
|
|
868
|
+
value: string;
|
|
869
|
+
ttl: number;
|
|
870
|
+
priority: number;
|
|
871
|
+
comment?: string;
|
|
872
|
+
}): Promise<Models.DnsRecord>;
|
|
873
|
+
/**
|
|
874
|
+
* Update an existing MX record for the given domain.
|
|
875
|
+
*
|
|
876
|
+
* @param {string} domainId - Domain unique ID.
|
|
877
|
+
* @param {string} recordId - DNS record unique ID.
|
|
878
|
+
* @param {string} name - Record name (subdomain).
|
|
879
|
+
* @param {string} value - Mail server domain for this MX record.
|
|
880
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
881
|
+
* @param {number} priority - MX priority.
|
|
882
|
+
* @param {string} comment - A comment for this record.
|
|
883
|
+
* @throws {AppwriteException}
|
|
884
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
885
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
886
|
+
*/
|
|
887
|
+
updateRecordMX(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, comment?: string): Promise<Models.DnsRecord>;
|
|
888
|
+
/**
|
|
889
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
890
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
891
|
+
*
|
|
892
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
893
|
+
* @param {string} params.name - Record name (subdomain).
|
|
894
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
895
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
896
|
+
* @param {string} params.comment - A comment for this record.
|
|
897
|
+
* @throws {AppwriteException}
|
|
898
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
899
|
+
*/
|
|
900
|
+
createRecordNS(params: {
|
|
901
|
+
domainId: string;
|
|
902
|
+
name: string;
|
|
903
|
+
value: string;
|
|
904
|
+
ttl: number;
|
|
905
|
+
comment?: string;
|
|
906
|
+
}): Promise<Models.DnsRecord>;
|
|
907
|
+
/**
|
|
908
|
+
* Create a new NS record for the given domain. NS records specify the nameservers that are used
|
|
909
|
+
* to resolve the domain name to IP addresses. Each domain can have multiple NS records.
|
|
910
|
+
*
|
|
911
|
+
* @param {string} domainId - Domain unique ID.
|
|
912
|
+
* @param {string} name - Record name (subdomain).
|
|
913
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
914
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
915
|
+
* @param {string} comment - A comment for this record.
|
|
916
|
+
* @throws {AppwriteException}
|
|
917
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
918
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
919
|
+
*/
|
|
920
|
+
createRecordNS(domainId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
921
|
+
/**
|
|
922
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
923
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
924
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
925
|
+
* for better record management.
|
|
926
|
+
*
|
|
927
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
928
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
929
|
+
* @param {string} params.name - Record name (subdomain).
|
|
930
|
+
* @param {string} params.value - Nameserver target for this NS record.
|
|
931
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
932
|
+
* @param {string} params.comment - A comment for this record.
|
|
933
|
+
* @throws {AppwriteException}
|
|
934
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
935
|
+
*/
|
|
936
|
+
updateRecordNS(params: {
|
|
937
|
+
domainId: string;
|
|
938
|
+
recordId: string;
|
|
939
|
+
name: string;
|
|
940
|
+
value: string;
|
|
941
|
+
ttl: number;
|
|
942
|
+
comment?: string;
|
|
943
|
+
}): Promise<Models.DnsRecord>;
|
|
944
|
+
/**
|
|
945
|
+
* Update an existing NS record for the given domain. This endpoint allows you to modify
|
|
946
|
+
* the properties of an NS (nameserver) record associated with your domain. You can update
|
|
947
|
+
* the record name (subdomain), target nameserver value, TTL, and add or modify comments
|
|
948
|
+
* for better record management.
|
|
949
|
+
*
|
|
950
|
+
* @param {string} domainId - Domain unique ID.
|
|
951
|
+
* @param {string} recordId - DNS record unique ID.
|
|
952
|
+
* @param {string} name - Record name (subdomain).
|
|
953
|
+
* @param {string} value - Nameserver target for this NS record.
|
|
954
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
955
|
+
* @param {string} comment - A comment for this record.
|
|
956
|
+
* @throws {AppwriteException}
|
|
957
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
958
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
959
|
+
*/
|
|
960
|
+
updateRecordNS(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
961
|
+
/**
|
|
962
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
963
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
964
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
965
|
+
*
|
|
966
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
967
|
+
* @param {string} params.name - Record name (service name).
|
|
968
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
969
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
970
|
+
* @param {number} params.priority - Record priority.
|
|
971
|
+
* @param {number} params.weight - Record weight.
|
|
972
|
+
* @param {number} params.port - Port number for the service.
|
|
973
|
+
* @param {string} params.comment - A comment for this record.
|
|
974
|
+
* @throws {AppwriteException}
|
|
975
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
976
|
+
*/
|
|
977
|
+
createRecordSRV(params: {
|
|
978
|
+
domainId: string;
|
|
979
|
+
name: string;
|
|
980
|
+
value: string;
|
|
981
|
+
ttl: number;
|
|
982
|
+
priority: number;
|
|
983
|
+
weight: number;
|
|
984
|
+
port: number;
|
|
985
|
+
comment?: string;
|
|
986
|
+
}): Promise<Models.DnsRecord>;
|
|
987
|
+
/**
|
|
988
|
+
* Create a new SRV record for the given domain. SRV records are used to define the location
|
|
989
|
+
* of servers for specific services. For example, they can be used to specify which server
|
|
990
|
+
* handles a specific service like SIP or XMPP for the domain.
|
|
991
|
+
*
|
|
992
|
+
* @param {string} domainId - Domain unique ID.
|
|
993
|
+
* @param {string} name - Record name (service name).
|
|
994
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
995
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
996
|
+
* @param {number} priority - Record priority.
|
|
997
|
+
* @param {number} weight - Record weight.
|
|
998
|
+
* @param {number} port - Port number for the service.
|
|
999
|
+
* @param {string} comment - A comment for this record.
|
|
1000
|
+
* @throws {AppwriteException}
|
|
1001
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1002
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1003
|
+
*/
|
|
1004
|
+
createRecordSRV(domainId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1005
|
+
/**
|
|
1006
|
+
* Update an existing SRV record for the given domain.
|
|
1007
|
+
*
|
|
1008
|
+
* Required parameters:
|
|
1009
|
+
* - domainId: Domain unique ID
|
|
1010
|
+
* - recordId: DNS record unique ID
|
|
1011
|
+
* - name: Record name (service name)
|
|
1012
|
+
* - value: Target hostname for this SRV record
|
|
1013
|
+
* - ttl: Time to live, in seconds
|
|
1014
|
+
* - priority: Record priority
|
|
1015
|
+
* - weight: Record weight
|
|
1016
|
+
* - port: Port number for the service
|
|
1017
|
+
*
|
|
1018
|
+
* Optional parameters:
|
|
1019
|
+
* - comment: A comment for this record
|
|
1020
|
+
*
|
|
1021
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1022
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1023
|
+
* @param {string} params.name - Record name (service name).
|
|
1024
|
+
* @param {string} params.value - Target hostname for this SRV record.
|
|
1025
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1026
|
+
* @param {number} params.priority - Record priority.
|
|
1027
|
+
* @param {number} params.weight - Record weight.
|
|
1028
|
+
* @param {number} params.port - Port number for the service.
|
|
1029
|
+
* @param {string} params.comment - A comment for this record.
|
|
1030
|
+
* @throws {AppwriteException}
|
|
1031
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1032
|
+
*/
|
|
1033
|
+
updateRecordSRV(params: {
|
|
1034
|
+
domainId: string;
|
|
1035
|
+
recordId: string;
|
|
1036
|
+
name: string;
|
|
1037
|
+
value: string;
|
|
1038
|
+
ttl: number;
|
|
1039
|
+
priority: number;
|
|
1040
|
+
weight: number;
|
|
1041
|
+
port: number;
|
|
1042
|
+
comment?: string;
|
|
1043
|
+
}): Promise<Models.DnsRecord>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Update an existing SRV record for the given domain.
|
|
1046
|
+
*
|
|
1047
|
+
* Required parameters:
|
|
1048
|
+
* - domainId: Domain unique ID
|
|
1049
|
+
* - recordId: DNS record unique ID
|
|
1050
|
+
* - name: Record name (service name)
|
|
1051
|
+
* - value: Target hostname for this SRV record
|
|
1052
|
+
* - ttl: Time to live, in seconds
|
|
1053
|
+
* - priority: Record priority
|
|
1054
|
+
* - weight: Record weight
|
|
1055
|
+
* - port: Port number for the service
|
|
1056
|
+
*
|
|
1057
|
+
* Optional parameters:
|
|
1058
|
+
* - comment: A comment for this record
|
|
1059
|
+
*
|
|
1060
|
+
* @param {string} domainId - Domain unique ID.
|
|
1061
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1062
|
+
* @param {string} name - Record name (service name).
|
|
1063
|
+
* @param {string} value - Target hostname for this SRV record.
|
|
1064
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1065
|
+
* @param {number} priority - Record priority.
|
|
1066
|
+
* @param {number} weight - Record weight.
|
|
1067
|
+
* @param {number} port - Port number for the service.
|
|
1068
|
+
* @param {string} comment - A comment for this record.
|
|
1069
|
+
* @throws {AppwriteException}
|
|
1070
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1071
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1072
|
+
*/
|
|
1073
|
+
updateRecordSRV(domainId: string, recordId: string, name: string, value: string, ttl: number, priority: number, weight: number, port: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1074
|
+
/**
|
|
1075
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
1076
|
+
* to provide additional information about your domain, such as domain
|
|
1077
|
+
* verification records, SPF records, or DKIM records.
|
|
1078
|
+
*
|
|
1079
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1080
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
1081
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1082
|
+
* @param {string} params.value - TXT record value.
|
|
1083
|
+
* @param {string} params.comment - A comment for this record.
|
|
1084
|
+
* @throws {AppwriteException}
|
|
1085
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1086
|
+
*/
|
|
1087
|
+
createRecordTXT(params: {
|
|
1088
|
+
domainId: string;
|
|
1089
|
+
name: string;
|
|
1090
|
+
ttl: number;
|
|
1091
|
+
value?: string;
|
|
1092
|
+
comment?: string;
|
|
1093
|
+
}): Promise<Models.DnsRecord>;
|
|
1094
|
+
/**
|
|
1095
|
+
* Create a new TXT record for the given domain. TXT records can be used
|
|
1096
|
+
* to provide additional information about your domain, such as domain
|
|
1097
|
+
* verification records, SPF records, or DKIM records.
|
|
1098
|
+
*
|
|
1099
|
+
* @param {string} domainId - Domain unique ID.
|
|
1100
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
1101
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1102
|
+
* @param {string} value - TXT record value.
|
|
1103
|
+
* @param {string} comment - A comment for this record.
|
|
1104
|
+
* @throws {AppwriteException}
|
|
1105
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1106
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1107
|
+
*/
|
|
1108
|
+
createRecordTXT(domainId: string, name: string, ttl: number, value?: string, comment?: string): Promise<Models.DnsRecord>;
|
|
1109
|
+
/**
|
|
1110
|
+
* Update an existing TXT record for the given domain.
|
|
1111
|
+
*
|
|
1112
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1113
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1114
|
+
*
|
|
1115
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1116
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1117
|
+
* @param {string} params.name - Record name (subdomain) for the TXT record.
|
|
1118
|
+
* @param {string} params.value - TXT record value.
|
|
1119
|
+
* @param {number} params.ttl - Time to live, in seconds. Must be greater than 0.
|
|
1120
|
+
* @param {string} params.comment - A comment for this record.
|
|
1121
|
+
* @throws {AppwriteException}
|
|
1122
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1123
|
+
*/
|
|
1124
|
+
updateRecordTXT(params: {
|
|
1125
|
+
domainId: string;
|
|
1126
|
+
recordId: string;
|
|
1127
|
+
name: string;
|
|
1128
|
+
value: string;
|
|
1129
|
+
ttl: number;
|
|
1130
|
+
comment?: string;
|
|
1131
|
+
}): Promise<Models.DnsRecord>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Update an existing TXT record for the given domain.
|
|
1134
|
+
*
|
|
1135
|
+
* Update the TXT record details for a specific domain by providing the domain ID,
|
|
1136
|
+
* record ID, and the new record configuration including name, value, TTL, and an optional comment.
|
|
1137
|
+
*
|
|
1138
|
+
* @param {string} domainId - Domain unique ID.
|
|
1139
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1140
|
+
* @param {string} name - Record name (subdomain) for the TXT record.
|
|
1141
|
+
* @param {string} value - TXT record value.
|
|
1142
|
+
* @param {number} ttl - Time to live, in seconds. Must be greater than 0.
|
|
1143
|
+
* @param {string} comment - A comment for this record.
|
|
1144
|
+
* @throws {AppwriteException}
|
|
1145
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1146
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1147
|
+
*/
|
|
1148
|
+
updateRecordTXT(domainId: string, recordId: string, name: string, value: string, ttl: number, comment?: string): Promise<Models.DnsRecord>;
|
|
1149
|
+
/**
|
|
1150
|
+
* Get a single DNS record for a given domain by record ID.
|
|
1151
|
+
*
|
|
1152
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
1153
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
1154
|
+
* such as type, value, and TTL settings.
|
|
1155
|
+
*
|
|
1156
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1157
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1158
|
+
* @throws {AppwriteException}
|
|
1159
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1160
|
+
*/
|
|
1161
|
+
getRecord(params: {
|
|
1162
|
+
domainId: string;
|
|
1163
|
+
recordId: string;
|
|
1164
|
+
}): Promise<Models.DnsRecord>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Get a single DNS record for a given domain by record ID.
|
|
1167
|
+
*
|
|
1168
|
+
* This endpoint allows you to retrieve a specific DNS record associated with a domain
|
|
1169
|
+
* using its unique identifier. The record contains information about the DNS configuration
|
|
1170
|
+
* such as type, value, and TTL settings.
|
|
1171
|
+
*
|
|
1172
|
+
* @param {string} domainId - Domain unique ID.
|
|
1173
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1174
|
+
* @throws {AppwriteException}
|
|
1175
|
+
* @returns {Promise<Models.DnsRecord>}
|
|
1176
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1177
|
+
*/
|
|
1178
|
+
getRecord(domainId: string, recordId: string): Promise<Models.DnsRecord>;
|
|
1179
|
+
/**
|
|
1180
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1181
|
+
* from a specific domain.
|
|
1182
|
+
*
|
|
1183
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1184
|
+
* @param {string} params.recordId - DNS record unique ID.
|
|
1185
|
+
* @throws {AppwriteException}
|
|
1186
|
+
* @returns {Promise<{}>}
|
|
1187
|
+
*/
|
|
1188
|
+
deleteRecord(params: {
|
|
1189
|
+
domainId: string;
|
|
1190
|
+
recordId: string;
|
|
1191
|
+
}): Promise<{}>;
|
|
1192
|
+
/**
|
|
1193
|
+
* Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record
|
|
1194
|
+
* from a specific domain.
|
|
1195
|
+
*
|
|
1196
|
+
* @param {string} domainId - Domain unique ID.
|
|
1197
|
+
* @param {string} recordId - DNS record unique ID.
|
|
1198
|
+
* @throws {AppwriteException}
|
|
1199
|
+
* @returns {Promise<{}>}
|
|
1200
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1201
|
+
*/
|
|
1202
|
+
deleteRecord(domainId: string, recordId: string): Promise<{}>;
|
|
1203
|
+
/**
|
|
1204
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1205
|
+
*
|
|
1206
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
1207
|
+
* and all its DNS records to the new team.
|
|
1208
|
+
*
|
|
1209
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1210
|
+
* @param {string} params.teamId - New team unique ID.
|
|
1211
|
+
* @throws {AppwriteException}
|
|
1212
|
+
* @returns {Promise<Models.Domain>}
|
|
1213
|
+
*/
|
|
1214
|
+
updateTeam(params: {
|
|
1215
|
+
domainId: string;
|
|
1216
|
+
teamId: string;
|
|
1217
|
+
}): Promise<Models.Domain>;
|
|
1218
|
+
/**
|
|
1219
|
+
* Update the team ID for a specific domain. This endpoint requires admin access.
|
|
1220
|
+
*
|
|
1221
|
+
* Updating the team ID will transfer ownership and access control of the domain
|
|
1222
|
+
* and all its DNS records to the new team.
|
|
1223
|
+
*
|
|
1224
|
+
* @param {string} domainId - Domain unique ID.
|
|
1225
|
+
* @param {string} teamId - New team unique ID.
|
|
1226
|
+
* @throws {AppwriteException}
|
|
1227
|
+
* @returns {Promise<Models.Domain>}
|
|
1228
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1229
|
+
*/
|
|
1230
|
+
updateTeam(domainId: string, teamId: string): Promise<Models.Domain>;
|
|
1231
|
+
/**
|
|
1232
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1233
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1234
|
+
*
|
|
1235
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1236
|
+
* @throws {AppwriteException}
|
|
1237
|
+
* @returns {Promise<{}>}
|
|
1238
|
+
*/
|
|
1239
|
+
getZone(params: {
|
|
1240
|
+
domainId: string;
|
|
1241
|
+
}): Promise<{}>;
|
|
1242
|
+
/**
|
|
1243
|
+
* Retrieve the DNS zone file for the given domain. This endpoint will return the DNS
|
|
1244
|
+
* zone file in a standardized format that can be used to configure DNS servers.
|
|
1245
|
+
*
|
|
1246
|
+
* @param {string} domainId - Domain unique ID.
|
|
1247
|
+
* @throws {AppwriteException}
|
|
1248
|
+
* @returns {Promise<{}>}
|
|
1249
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1250
|
+
*/
|
|
1251
|
+
getZone(domainId: string): Promise<{}>;
|
|
1252
|
+
/**
|
|
1253
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1254
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
1255
|
+
*
|
|
1256
|
+
* @param {string} params.domainId - Domain unique ID.
|
|
1257
|
+
* @param {string} params.content - DNS zone file content as a string.
|
|
1258
|
+
* @throws {AppwriteException}
|
|
1259
|
+
* @returns {Promise<Models.Domain>}
|
|
1260
|
+
*/
|
|
1261
|
+
updateZone(params: {
|
|
1262
|
+
domainId: string;
|
|
1263
|
+
content: string;
|
|
1264
|
+
}): Promise<Models.Domain>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Update the DNS zone for the given domain using the provided zone file content.
|
|
1267
|
+
* All parsed records are imported and then the main domain document is returned.
|
|
1268
|
+
*
|
|
1269
|
+
* @param {string} domainId - Domain unique ID.
|
|
1270
|
+
* @param {string} content - DNS zone file content as a string.
|
|
1271
|
+
* @throws {AppwriteException}
|
|
1272
|
+
* @returns {Promise<Models.Domain>}
|
|
1273
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1274
|
+
*/
|
|
1275
|
+
updateZone(domainId: string, content: string): Promise<Models.Domain>;
|
|
1276
|
+
}
|