@appwrite.io/console 7.0.0 → 8.1.0

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