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.
Files changed (105) hide show
  1. package/LICENSE +12 -0
  2. package/README.md +191 -0
  3. package/dist/cjs/package.json +3 -0
  4. package/dist/cjs/sdk.js +27712 -0
  5. package/dist/cjs/sdk.js.map +1 -0
  6. package/dist/esm/package.json +3 -0
  7. package/dist/esm/sdk.js +27675 -0
  8. package/dist/esm/sdk.js.map +1 -0
  9. package/dist/iife/sdk.js +27716 -0
  10. package/package.json +47 -0
  11. package/types/client.d.ts +211 -0
  12. package/types/enums/adapter.d.ts +4 -0
  13. package/types/enums/api-service.d.ts +15 -0
  14. package/types/enums/api.d.ts +5 -0
  15. package/types/enums/attribute-status.d.ts +7 -0
  16. package/types/enums/auth-method.d.ts +9 -0
  17. package/types/enums/authentication-factor.d.ts +6 -0
  18. package/types/enums/authenticator-type.d.ts +3 -0
  19. package/types/enums/billing-plan.d.ts +10 -0
  20. package/types/enums/browser.d.ts +16 -0
  21. package/types/enums/build-runtime.d.ts +66 -0
  22. package/types/enums/column-status.d.ts +7 -0
  23. package/types/enums/compression.d.ts +5 -0
  24. package/types/enums/console-resource-type.d.ts +3 -0
  25. package/types/enums/credit-card.d.ts +19 -0
  26. package/types/enums/database-type.d.ts +4 -0
  27. package/types/enums/deployment-download-type.d.ts +4 -0
  28. package/types/enums/deployment-status.d.ts +7 -0
  29. package/types/enums/email-template-locale.d.ts +133 -0
  30. package/types/enums/email-template-type.d.ts +9 -0
  31. package/types/enums/execution-method.d.ts +9 -0
  32. package/types/enums/execution-status.d.ts +7 -0
  33. package/types/enums/execution-trigger.d.ts +5 -0
  34. package/types/enums/flag.d.ts +197 -0
  35. package/types/enums/framework.d.ts +17 -0
  36. package/types/enums/health-antivirus-status.d.ts +5 -0
  37. package/types/enums/health-check-status.d.ts +4 -0
  38. package/types/enums/image-format.d.ts +9 -0
  39. package/types/enums/image-gravity.d.ts +11 -0
  40. package/types/enums/index-status.d.ts +7 -0
  41. package/types/enums/index-type.d.ts +6 -0
  42. package/types/enums/message-priority.d.ts +4 -0
  43. package/types/enums/message-status.d.ts +7 -0
  44. package/types/enums/messaging-provider-type.d.ts +5 -0
  45. package/types/enums/name.d.ts +14 -0
  46. package/types/enums/o-auth-provider.d.ts +43 -0
  47. package/types/enums/output.d.ts +9 -0
  48. package/types/enums/password-hash.d.ts +13 -0
  49. package/types/enums/platform-type.d.ts +17 -0
  50. package/types/enums/platform.d.ts +4 -0
  51. package/types/enums/project-usage-range.d.ts +4 -0
  52. package/types/enums/proxy-resource-type.d.ts +4 -0
  53. package/types/enums/proxy-rule-deployment-resource-type.d.ts +4 -0
  54. package/types/enums/proxy-rule-status.d.ts +6 -0
  55. package/types/enums/region.d.ts +8 -0
  56. package/types/enums/relation-mutate.d.ts +5 -0
  57. package/types/enums/relationship-type.d.ts +6 -0
  58. package/types/enums/runtime.d.ts +66 -0
  59. package/types/enums/sms-template-locale.d.ts +133 -0
  60. package/types/enums/sms-template-type.d.ts +6 -0
  61. package/types/enums/smtp-encryption.d.ts +5 -0
  62. package/types/enums/smtp-secure.d.ts +4 -0
  63. package/types/enums/status-code.d.ts +6 -0
  64. package/types/enums/status.d.ts +4 -0
  65. package/types/enums/theme.d.ts +4 -0
  66. package/types/enums/timezone.d.ts +421 -0
  67. package/types/enums/type.d.ts +5 -0
  68. package/types/enums/usage-range.d.ts +5 -0
  69. package/types/enums/vcs-deployment-type.d.ts +5 -0
  70. package/types/enums/vcs-detection-type.d.ts +4 -0
  71. package/types/id.d.ts +20 -0
  72. package/types/index.d.ts +102 -0
  73. package/types/migrations.d.ts +240 -0
  74. package/types/models.d.ts +7945 -0
  75. package/types/operator.d.ts +180 -0
  76. package/types/permission.d.ts +43 -0
  77. package/types/query.d.ts +390 -0
  78. package/types/role.d.ts +70 -0
  79. package/types/sdk.d.ts +108 -0
  80. package/types/service.d.ts +11 -0
  81. package/types/services/account.d.ts +1413 -0
  82. package/types/services/assistant.d.ts +24 -0
  83. package/types/services/avatars.d.ts +319 -0
  84. package/types/services/backups.d.ts +276 -0
  85. package/types/services/console.d.ts +210 -0
  86. package/types/services/databases.d.ts +2119 -0
  87. package/types/services/domains.d.ts +1276 -0
  88. package/types/services/functions.d.ts +827 -0
  89. package/types/services/graphql.d.ts +43 -0
  90. package/types/services/health.d.ts +432 -0
  91. package/types/services/locale.d.ts +64 -0
  92. package/types/services/messaging.d.ts +1989 -0
  93. package/types/services/migrations.d.ts +413 -0
  94. package/types/services/organizations.d.ts +842 -0
  95. package/types/services/project.d.ts +130 -0
  96. package/types/services/projects.d.ts +1663 -0
  97. package/types/services/proxy.d.ts +190 -0
  98. package/types/services/realtime.d.ts +118 -0
  99. package/types/services/sites.d.ts +780 -0
  100. package/types/services/storage.d.ts +467 -0
  101. package/types/services/tables-db.d.ts +2034 -0
  102. package/types/services/teams.d.ts +366 -0
  103. package/types/services/tokens.d.ts +119 -0
  104. package/types/services/users.d.ts +1184 -0
  105. package/types/services/vcs.d.ts +249 -0
@@ -0,0 +1,1663 @@
1
+ import { Client } from '../client';
2
+ import type { Models } from '../models';
3
+ import { Region } from '../enums/region';
4
+ import { Api } from '../enums/api';
5
+ import { AuthMethod } from '../enums/auth-method';
6
+ import { OAuthProvider } from '../enums/o-auth-provider';
7
+ import { PlatformType } from '../enums/platform-type';
8
+ import { ApiService } from '../enums/api-service';
9
+ import { SMTPSecure } from '../enums/smtp-secure';
10
+ import { Status } from '../enums/status';
11
+ import { EmailTemplateType } from '../enums/email-template-type';
12
+ import { EmailTemplateLocale } from '../enums/email-template-locale';
13
+ import { SmsTemplateType } from '../enums/sms-template-type';
14
+ import { SmsTemplateLocale } from '../enums/sms-template-locale';
15
+ export declare class Projects {
16
+ client: Client;
17
+ constructor(client: Client);
18
+ /**
19
+ * Get a list of all projects. You can use the query params to filter your results.
20
+ *
21
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId
22
+ * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
23
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
24
+ * @throws {AppwriteException}
25
+ * @returns {Promise<Models.ProjectList>}
26
+ */
27
+ list(params?: {
28
+ queries?: string[];
29
+ search?: string;
30
+ total?: boolean;
31
+ }): Promise<Models.ProjectList>;
32
+ /**
33
+ * Get a list of all projects. You can use the query params to filter your results.
34
+ *
35
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, teamId
36
+ * @param {string} search - Search term to filter your list results. Max length: 256 chars.
37
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
38
+ * @throws {AppwriteException}
39
+ * @returns {Promise<Models.ProjectList>}
40
+ * @deprecated Use the object parameter style method for a better developer experience.
41
+ */
42
+ list(queries?: string[], search?: string, total?: boolean): Promise<Models.ProjectList>;
43
+ /**
44
+ * Create a new project. You can create a maximum of 100 projects per account.
45
+ *
46
+ * @param {string} params.projectId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
47
+ * @param {string} params.name - Project name. Max length: 128 chars.
48
+ * @param {string} params.teamId - Team unique ID.
49
+ * @param {Region} params.region - Project Region.
50
+ * @param {string} params.description - Project description. Max length: 256 chars.
51
+ * @param {string} params.logo - Project logo.
52
+ * @param {string} params.url - Project URL.
53
+ * @param {string} params.legalName - Project legal Name. Max length: 256 chars.
54
+ * @param {string} params.legalCountry - Project legal Country. Max length: 256 chars.
55
+ * @param {string} params.legalState - Project legal State. Max length: 256 chars.
56
+ * @param {string} params.legalCity - Project legal City. Max length: 256 chars.
57
+ * @param {string} params.legalAddress - Project legal Address. Max length: 256 chars.
58
+ * @param {string} params.legalTaxId - Project legal Tax ID. Max length: 256 chars.
59
+ * @throws {AppwriteException}
60
+ * @returns {Promise<Models.Project>}
61
+ */
62
+ create(params: {
63
+ projectId: string;
64
+ name: string;
65
+ teamId: string;
66
+ region?: Region;
67
+ description?: string;
68
+ logo?: string;
69
+ url?: string;
70
+ legalName?: string;
71
+ legalCountry?: string;
72
+ legalState?: string;
73
+ legalCity?: string;
74
+ legalAddress?: string;
75
+ legalTaxId?: string;
76
+ }): Promise<Models.Project>;
77
+ /**
78
+ * Create a new project. You can create a maximum of 100 projects per account.
79
+ *
80
+ * @param {string} projectId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.
81
+ * @param {string} name - Project name. Max length: 128 chars.
82
+ * @param {string} teamId - Team unique ID.
83
+ * @param {Region} region - Project Region.
84
+ * @param {string} description - Project description. Max length: 256 chars.
85
+ * @param {string} logo - Project logo.
86
+ * @param {string} url - Project URL.
87
+ * @param {string} legalName - Project legal Name. Max length: 256 chars.
88
+ * @param {string} legalCountry - Project legal Country. Max length: 256 chars.
89
+ * @param {string} legalState - Project legal State. Max length: 256 chars.
90
+ * @param {string} legalCity - Project legal City. Max length: 256 chars.
91
+ * @param {string} legalAddress - Project legal Address. Max length: 256 chars.
92
+ * @param {string} legalTaxId - Project legal Tax ID. Max length: 256 chars.
93
+ * @throws {AppwriteException}
94
+ * @returns {Promise<Models.Project>}
95
+ * @deprecated Use the object parameter style method for a better developer experience.
96
+ */
97
+ create(projectId: string, name: string, teamId: string, region?: Region, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
98
+ /**
99
+ * Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata.
100
+ *
101
+ * @param {string} params.projectId - Project unique ID.
102
+ * @throws {AppwriteException}
103
+ * @returns {Promise<Models.Project>}
104
+ */
105
+ get(params: {
106
+ projectId: string;
107
+ }): Promise<Models.Project>;
108
+ /**
109
+ * Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata.
110
+ *
111
+ * @param {string} projectId - Project unique ID.
112
+ * @throws {AppwriteException}
113
+ * @returns {Promise<Models.Project>}
114
+ * @deprecated Use the object parameter style method for a better developer experience.
115
+ */
116
+ get(projectId: string): Promise<Models.Project>;
117
+ /**
118
+ * Update a project by its unique ID.
119
+ *
120
+ * @param {string} params.projectId - Project unique ID.
121
+ * @param {string} params.name - Project name. Max length: 128 chars.
122
+ * @param {string} params.description - Project description. Max length: 256 chars.
123
+ * @param {string} params.logo - Project logo.
124
+ * @param {string} params.url - Project URL.
125
+ * @param {string} params.legalName - Project legal name. Max length: 256 chars.
126
+ * @param {string} params.legalCountry - Project legal country. Max length: 256 chars.
127
+ * @param {string} params.legalState - Project legal state. Max length: 256 chars.
128
+ * @param {string} params.legalCity - Project legal city. Max length: 256 chars.
129
+ * @param {string} params.legalAddress - Project legal address. Max length: 256 chars.
130
+ * @param {string} params.legalTaxId - Project legal tax ID. Max length: 256 chars.
131
+ * @throws {AppwriteException}
132
+ * @returns {Promise<Models.Project>}
133
+ */
134
+ update(params: {
135
+ projectId: string;
136
+ name: string;
137
+ description?: string;
138
+ logo?: string;
139
+ url?: string;
140
+ legalName?: string;
141
+ legalCountry?: string;
142
+ legalState?: string;
143
+ legalCity?: string;
144
+ legalAddress?: string;
145
+ legalTaxId?: string;
146
+ }): Promise<Models.Project>;
147
+ /**
148
+ * Update a project by its unique ID.
149
+ *
150
+ * @param {string} projectId - Project unique ID.
151
+ * @param {string} name - Project name. Max length: 128 chars.
152
+ * @param {string} description - Project description. Max length: 256 chars.
153
+ * @param {string} logo - Project logo.
154
+ * @param {string} url - Project URL.
155
+ * @param {string} legalName - Project legal name. Max length: 256 chars.
156
+ * @param {string} legalCountry - Project legal country. Max length: 256 chars.
157
+ * @param {string} legalState - Project legal state. Max length: 256 chars.
158
+ * @param {string} legalCity - Project legal city. Max length: 256 chars.
159
+ * @param {string} legalAddress - Project legal address. Max length: 256 chars.
160
+ * @param {string} legalTaxId - Project legal tax ID. Max length: 256 chars.
161
+ * @throws {AppwriteException}
162
+ * @returns {Promise<Models.Project>}
163
+ * @deprecated Use the object parameter style method for a better developer experience.
164
+ */
165
+ update(projectId: string, name: string, description?: string, logo?: string, url?: string, legalName?: string, legalCountry?: string, legalState?: string, legalCity?: string, legalAddress?: string, legalTaxId?: string): Promise<Models.Project>;
166
+ /**
167
+ * Delete a project by its unique ID.
168
+ *
169
+ * @param {string} params.projectId - Project unique ID.
170
+ * @throws {AppwriteException}
171
+ * @returns {Promise<{}>}
172
+ */
173
+ delete(params: {
174
+ projectId: string;
175
+ }): Promise<{}>;
176
+ /**
177
+ * Delete a project by its unique ID.
178
+ *
179
+ * @param {string} projectId - Project unique ID.
180
+ * @throws {AppwriteException}
181
+ * @returns {Promise<{}>}
182
+ * @deprecated Use the object parameter style method for a better developer experience.
183
+ */
184
+ delete(projectId: string): Promise<{}>;
185
+ /**
186
+ * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
187
+ *
188
+ * @param {string} params.projectId - Project unique ID.
189
+ * @param {Api} params.api - API name.
190
+ * @param {boolean} params.status - API status.
191
+ * @throws {AppwriteException}
192
+ * @returns {Promise<Models.Project>}
193
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatus` instead.
194
+ */
195
+ updateApiStatus(params: {
196
+ projectId: string;
197
+ api: Api;
198
+ status: boolean;
199
+ }): Promise<Models.Project>;
200
+ /**
201
+ * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
202
+ *
203
+ * @param {string} projectId - Project unique ID.
204
+ * @param {Api} api - API name.
205
+ * @param {boolean} status - API status.
206
+ * @throws {AppwriteException}
207
+ * @returns {Promise<Models.Project>}
208
+ * @deprecated Use the object parameter style method for a better developer experience.
209
+ */
210
+ updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
211
+ /**
212
+ * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
213
+ *
214
+ * @param {string} params.projectId - Project unique ID.
215
+ * @param {Api} params.api - API name.
216
+ * @param {boolean} params.status - API status.
217
+ * @throws {AppwriteException}
218
+ * @returns {Promise<Models.Project>}
219
+ */
220
+ updateAPIStatus(params: {
221
+ projectId: string;
222
+ api: Api;
223
+ status: boolean;
224
+ }): Promise<Models.Project>;
225
+ /**
226
+ * Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
227
+ *
228
+ * @param {string} projectId - Project unique ID.
229
+ * @param {Api} api - API name.
230
+ * @param {boolean} status - API status.
231
+ * @throws {AppwriteException}
232
+ * @returns {Promise<Models.Project>}
233
+ * @deprecated Use the object parameter style method for a better developer experience.
234
+ */
235
+ updateAPIStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
236
+ /**
237
+ * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
238
+ *
239
+ * @param {string} params.projectId - Project unique ID.
240
+ * @param {boolean} params.status - API status.
241
+ * @throws {AppwriteException}
242
+ * @returns {Promise<Models.Project>}
243
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateAPIStatusAll` instead.
244
+ */
245
+ updateApiStatusAll(params: {
246
+ projectId: string;
247
+ status: boolean;
248
+ }): Promise<Models.Project>;
249
+ /**
250
+ * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
251
+ *
252
+ * @param {string} projectId - Project unique ID.
253
+ * @param {boolean} status - API status.
254
+ * @throws {AppwriteException}
255
+ * @returns {Promise<Models.Project>}
256
+ * @deprecated Use the object parameter style method for a better developer experience.
257
+ */
258
+ updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
259
+ /**
260
+ * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
261
+ *
262
+ * @param {string} params.projectId - Project unique ID.
263
+ * @param {boolean} params.status - API status.
264
+ * @throws {AppwriteException}
265
+ * @returns {Promise<Models.Project>}
266
+ */
267
+ updateAPIStatusAll(params: {
268
+ projectId: string;
269
+ status: boolean;
270
+ }): Promise<Models.Project>;
271
+ /**
272
+ * Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
273
+ *
274
+ * @param {string} projectId - Project unique ID.
275
+ * @param {boolean} status - API status.
276
+ * @throws {AppwriteException}
277
+ * @returns {Promise<Models.Project>}
278
+ * @deprecated Use the object parameter style method for a better developer experience.
279
+ */
280
+ updateAPIStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
281
+ /**
282
+ * Update how long sessions created within a project should stay active for.
283
+ *
284
+ * @param {string} params.projectId - Project unique ID.
285
+ * @param {number} params.duration - Project session length in seconds. Max length: 31536000 seconds.
286
+ * @throws {AppwriteException}
287
+ * @returns {Promise<Models.Project>}
288
+ */
289
+ updateAuthDuration(params: {
290
+ projectId: string;
291
+ duration: number;
292
+ }): Promise<Models.Project>;
293
+ /**
294
+ * Update how long sessions created within a project should stay active for.
295
+ *
296
+ * @param {string} projectId - Project unique ID.
297
+ * @param {number} duration - Project session length in seconds. Max length: 31536000 seconds.
298
+ * @throws {AppwriteException}
299
+ * @returns {Promise<Models.Project>}
300
+ * @deprecated Use the object parameter style method for a better developer experience.
301
+ */
302
+ updateAuthDuration(projectId: string, duration: number): Promise<Models.Project>;
303
+ /**
304
+ * Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
305
+ *
306
+ * @param {string} params.projectId - Project unique ID.
307
+ * @param {number} params.limit - Set the max number of users allowed in this project. Use 0 for unlimited.
308
+ * @throws {AppwriteException}
309
+ * @returns {Promise<Models.Project>}
310
+ */
311
+ updateAuthLimit(params: {
312
+ projectId: string;
313
+ limit: number;
314
+ }): Promise<Models.Project>;
315
+ /**
316
+ * Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
317
+ *
318
+ * @param {string} projectId - Project unique ID.
319
+ * @param {number} limit - Set the max number of users allowed in this project. Use 0 for unlimited.
320
+ * @throws {AppwriteException}
321
+ * @returns {Promise<Models.Project>}
322
+ * @deprecated Use the object parameter style method for a better developer experience.
323
+ */
324
+ updateAuthLimit(projectId: string, limit: number): Promise<Models.Project>;
325
+ /**
326
+ * Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
327
+ *
328
+ * @param {string} params.projectId - Project unique ID.
329
+ * @param {number} params.limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
330
+ * @throws {AppwriteException}
331
+ * @returns {Promise<Models.Project>}
332
+ */
333
+ updateAuthSessionsLimit(params: {
334
+ projectId: string;
335
+ limit: number;
336
+ }): Promise<Models.Project>;
337
+ /**
338
+ * Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
339
+ *
340
+ * @param {string} projectId - Project unique ID.
341
+ * @param {number} limit - Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10
342
+ * @throws {AppwriteException}
343
+ * @returns {Promise<Models.Project>}
344
+ * @deprecated Use the object parameter style method for a better developer experience.
345
+ */
346
+ updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
347
+ /**
348
+ * Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
349
+ *
350
+ * @param {string} params.projectId - Project unique ID.
351
+ * @param {boolean} params.userName - Set to true to show userName to members of a team.
352
+ * @param {boolean} params.userEmail - Set to true to show email to members of a team.
353
+ * @param {boolean} params.mfa - Set to true to show mfa to members of a team.
354
+ * @throws {AppwriteException}
355
+ * @returns {Promise<Models.Project>}
356
+ */
357
+ updateMembershipsPrivacy(params: {
358
+ projectId: string;
359
+ userName: boolean;
360
+ userEmail: boolean;
361
+ mfa: boolean;
362
+ }): Promise<Models.Project>;
363
+ /**
364
+ * Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
365
+ *
366
+ * @param {string} projectId - Project unique ID.
367
+ * @param {boolean} userName - Set to true to show userName to members of a team.
368
+ * @param {boolean} userEmail - Set to true to show email to members of a team.
369
+ * @param {boolean} mfa - Set to true to show mfa to members of a team.
370
+ * @throws {AppwriteException}
371
+ * @returns {Promise<Models.Project>}
372
+ * @deprecated Use the object parameter style method for a better developer experience.
373
+ */
374
+ updateMembershipsPrivacy(projectId: string, userName: boolean, userEmail: boolean, mfa: boolean): Promise<Models.Project>;
375
+ /**
376
+ * Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
377
+ *
378
+ * @param {string} params.projectId - Project unique ID.
379
+ * @param {object[]} params.numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
380
+ * @throws {AppwriteException}
381
+ * @returns {Promise<Models.Project>}
382
+ */
383
+ updateMockNumbers(params: {
384
+ projectId: string;
385
+ numbers: object[];
386
+ }): Promise<Models.Project>;
387
+ /**
388
+ * Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
389
+ *
390
+ * @param {string} projectId - Project unique ID.
391
+ * @param {object[]} numbers - An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.
392
+ * @throws {AppwriteException}
393
+ * @returns {Promise<Models.Project>}
394
+ * @deprecated Use the object parameter style method for a better developer experience.
395
+ */
396
+ updateMockNumbers(projectId: string, numbers: object[]): Promise<Models.Project>;
397
+ /**
398
+ * Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
399
+ *
400
+ * @param {string} params.projectId - Project unique ID.
401
+ * @param {boolean} params.enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
402
+ * @throws {AppwriteException}
403
+ * @returns {Promise<Models.Project>}
404
+ */
405
+ updateAuthPasswordDictionary(params: {
406
+ projectId: string;
407
+ enabled: boolean;
408
+ }): Promise<Models.Project>;
409
+ /**
410
+ * Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
411
+ *
412
+ * @param {string} projectId - Project unique ID.
413
+ * @param {boolean} enabled - Set whether or not to enable checking user's password against most commonly used passwords. Default is false.
414
+ * @throws {AppwriteException}
415
+ * @returns {Promise<Models.Project>}
416
+ * @deprecated Use the object parameter style method for a better developer experience.
417
+ */
418
+ updateAuthPasswordDictionary(projectId: string, enabled: boolean): Promise<Models.Project>;
419
+ /**
420
+ * Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
421
+ *
422
+ * @param {string} params.projectId - Project unique ID.
423
+ * @param {number} params.limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
424
+ * @throws {AppwriteException}
425
+ * @returns {Promise<Models.Project>}
426
+ */
427
+ updateAuthPasswordHistory(params: {
428
+ projectId: string;
429
+ limit: number;
430
+ }): Promise<Models.Project>;
431
+ /**
432
+ * Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
433
+ *
434
+ * @param {string} projectId - Project unique ID.
435
+ * @param {number} limit - Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0
436
+ * @throws {AppwriteException}
437
+ * @returns {Promise<Models.Project>}
438
+ * @deprecated Use the object parameter style method for a better developer experience.
439
+ */
440
+ updateAuthPasswordHistory(projectId: string, limit: number): Promise<Models.Project>;
441
+ /**
442
+ * Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
443
+ *
444
+ * @param {string} params.projectId - Project unique ID.
445
+ * @param {boolean} params.enabled - Set whether or not to check a password for similarity with personal data. Default is false.
446
+ * @throws {AppwriteException}
447
+ * @returns {Promise<Models.Project>}
448
+ */
449
+ updatePersonalDataCheck(params: {
450
+ projectId: string;
451
+ enabled: boolean;
452
+ }): Promise<Models.Project>;
453
+ /**
454
+ * Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
455
+ *
456
+ * @param {string} projectId - Project unique ID.
457
+ * @param {boolean} enabled - Set whether or not to check a password for similarity with personal data. Default is false.
458
+ * @throws {AppwriteException}
459
+ * @returns {Promise<Models.Project>}
460
+ * @deprecated Use the object parameter style method for a better developer experience.
461
+ */
462
+ updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
463
+ /**
464
+ * Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
465
+ *
466
+ * @param {string} params.projectId - Project unique ID.
467
+ * @param {boolean} params.alerts - Set to true to enable session emails.
468
+ * @throws {AppwriteException}
469
+ * @returns {Promise<Models.Project>}
470
+ */
471
+ updateSessionAlerts(params: {
472
+ projectId: string;
473
+ alerts: boolean;
474
+ }): Promise<Models.Project>;
475
+ /**
476
+ * Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
477
+ *
478
+ * @param {string} projectId - Project unique ID.
479
+ * @param {boolean} alerts - Set to true to enable session emails.
480
+ * @throws {AppwriteException}
481
+ * @returns {Promise<Models.Project>}
482
+ * @deprecated Use the object parameter style method for a better developer experience.
483
+ */
484
+ updateSessionAlerts(projectId: string, alerts: boolean): Promise<Models.Project>;
485
+ /**
486
+ * Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
487
+ *
488
+ * @param {string} params.projectId - Project unique ID.
489
+ * @param {boolean} params.enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
490
+ * @throws {AppwriteException}
491
+ * @returns {Promise<Models.Project>}
492
+ */
493
+ updateSessionInvalidation(params: {
494
+ projectId: string;
495
+ enabled: boolean;
496
+ }): Promise<Models.Project>;
497
+ /**
498
+ * Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.
499
+ *
500
+ * @param {string} projectId - Project unique ID.
501
+ * @param {boolean} enabled - Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change
502
+ * @throws {AppwriteException}
503
+ * @returns {Promise<Models.Project>}
504
+ * @deprecated Use the object parameter style method for a better developer experience.
505
+ */
506
+ updateSessionInvalidation(projectId: string, enabled: boolean): Promise<Models.Project>;
507
+ /**
508
+ * Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
509
+ *
510
+ * @param {string} params.projectId - Project unique ID.
511
+ * @param {AuthMethod} params.method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
512
+ * @param {boolean} params.status - Set the status of this auth method.
513
+ * @throws {AppwriteException}
514
+ * @returns {Promise<Models.Project>}
515
+ */
516
+ updateAuthStatus(params: {
517
+ projectId: string;
518
+ method: AuthMethod;
519
+ status: boolean;
520
+ }): Promise<Models.Project>;
521
+ /**
522
+ * Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
523
+ *
524
+ * @param {string} projectId - Project unique ID.
525
+ * @param {AuthMethod} method - Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
526
+ * @param {boolean} status - Set the status of this auth method.
527
+ * @throws {AppwriteException}
528
+ * @returns {Promise<Models.Project>}
529
+ * @deprecated Use the object parameter style method for a better developer experience.
530
+ */
531
+ updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
532
+ /**
533
+ * List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
534
+ *
535
+ * @param {string} params.projectId - Project unique ID.
536
+ * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire
537
+ * @throws {AppwriteException}
538
+ * @returns {Promise<Models.DevKeyList>}
539
+ */
540
+ listDevKeys(params: {
541
+ projectId: string;
542
+ queries?: string[];
543
+ }): Promise<Models.DevKeyList>;
544
+ /**
545
+ * List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'
546
+ *
547
+ * @param {string} projectId - Project unique ID.
548
+ * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: accessedAt, expire
549
+ * @throws {AppwriteException}
550
+ * @returns {Promise<Models.DevKeyList>}
551
+ * @deprecated Use the object parameter style method for a better developer experience.
552
+ */
553
+ listDevKeys(projectId: string, queries?: string[]): Promise<Models.DevKeyList>;
554
+ /**
555
+ * Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
556
+ *
557
+ * @param {string} params.projectId - Project unique ID.
558
+ * @param {string} params.name - Key name. Max length: 128 chars.
559
+ * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
560
+ * @throws {AppwriteException}
561
+ * @returns {Promise<Models.DevKey>}
562
+ */
563
+ createDevKey(params: {
564
+ projectId: string;
565
+ name: string;
566
+ expire: string;
567
+ }): Promise<Models.DevKey>;
568
+ /**
569
+ * Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.
570
+ *
571
+ * @param {string} projectId - Project unique ID.
572
+ * @param {string} name - Key name. Max length: 128 chars.
573
+ * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
574
+ * @throws {AppwriteException}
575
+ * @returns {Promise<Models.DevKey>}
576
+ * @deprecated Use the object parameter style method for a better developer experience.
577
+ */
578
+ createDevKey(projectId: string, name: string, expire: string): Promise<Models.DevKey>;
579
+ /**
580
+ * Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
581
+ *
582
+ * @param {string} params.projectId - Project unique ID.
583
+ * @param {string} params.keyId - Key unique ID.
584
+ * @throws {AppwriteException}
585
+ * @returns {Promise<Models.DevKey>}
586
+ */
587
+ getDevKey(params: {
588
+ projectId: string;
589
+ keyId: string;
590
+ }): Promise<Models.DevKey>;
591
+ /**
592
+ * Get a project\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.
593
+ *
594
+ * @param {string} projectId - Project unique ID.
595
+ * @param {string} keyId - Key unique ID.
596
+ * @throws {AppwriteException}
597
+ * @returns {Promise<Models.DevKey>}
598
+ * @deprecated Use the object parameter style method for a better developer experience.
599
+ */
600
+ getDevKey(projectId: string, keyId: string): Promise<Models.DevKey>;
601
+ /**
602
+ * Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
603
+ *
604
+ * @param {string} params.projectId - Project unique ID.
605
+ * @param {string} params.keyId - Key unique ID.
606
+ * @param {string} params.name - Key name. Max length: 128 chars.
607
+ * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
608
+ * @throws {AppwriteException}
609
+ * @returns {Promise<Models.DevKey>}
610
+ */
611
+ updateDevKey(params: {
612
+ projectId: string;
613
+ keyId: string;
614
+ name: string;
615
+ expire: string;
616
+ }): Promise<Models.DevKey>;
617
+ /**
618
+ * Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
619
+ *
620
+ * @param {string} projectId - Project unique ID.
621
+ * @param {string} keyId - Key unique ID.
622
+ * @param {string} name - Key name. Max length: 128 chars.
623
+ * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
624
+ * @throws {AppwriteException}
625
+ * @returns {Promise<Models.DevKey>}
626
+ * @deprecated Use the object parameter style method for a better developer experience.
627
+ */
628
+ updateDevKey(projectId: string, keyId: string, name: string, expire: string): Promise<Models.DevKey>;
629
+ /**
630
+ * Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
631
+ *
632
+ * @param {string} params.projectId - Project unique ID.
633
+ * @param {string} params.keyId - Key unique ID.
634
+ * @throws {AppwriteException}
635
+ * @returns {Promise<{}>}
636
+ */
637
+ deleteDevKey(params: {
638
+ projectId: string;
639
+ keyId: string;
640
+ }): Promise<{}>;
641
+ /**
642
+ * Delete a project\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.
643
+ *
644
+ * @param {string} projectId - Project unique ID.
645
+ * @param {string} keyId - Key unique ID.
646
+ * @throws {AppwriteException}
647
+ * @returns {Promise<{}>}
648
+ * @deprecated Use the object parameter style method for a better developer experience.
649
+ */
650
+ deleteDevKey(projectId: string, keyId: string): Promise<{}>;
651
+ /**
652
+ * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
653
+ *
654
+ * @param {string} params.projectId - Project unique ID.
655
+ * @param {string[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
656
+ * @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
657
+ * @throws {AppwriteException}
658
+ * @returns {Promise<Models.Jwt>}
659
+ */
660
+ createJWT(params: {
661
+ projectId: string;
662
+ scopes: string[];
663
+ duration?: number;
664
+ }): Promise<Models.Jwt>;
665
+ /**
666
+ * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
667
+ *
668
+ * @param {string} projectId - Project unique ID.
669
+ * @param {string[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
670
+ * @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
671
+ * @throws {AppwriteException}
672
+ * @returns {Promise<Models.Jwt>}
673
+ * @deprecated Use the object parameter style method for a better developer experience.
674
+ */
675
+ createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
676
+ /**
677
+ * Get a list of all API keys from the current project.
678
+ *
679
+ * @param {string} params.projectId - Project unique ID.
680
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
681
+ * @throws {AppwriteException}
682
+ * @returns {Promise<Models.KeyList>}
683
+ */
684
+ listKeys(params: {
685
+ projectId: string;
686
+ total?: boolean;
687
+ }): Promise<Models.KeyList>;
688
+ /**
689
+ * Get a list of all API keys from the current project.
690
+ *
691
+ * @param {string} projectId - Project unique ID.
692
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
693
+ * @throws {AppwriteException}
694
+ * @returns {Promise<Models.KeyList>}
695
+ * @deprecated Use the object parameter style method for a better developer experience.
696
+ */
697
+ listKeys(projectId: string, total?: boolean): Promise<Models.KeyList>;
698
+ /**
699
+ * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
700
+ *
701
+ * @param {string} params.projectId - Project unique ID.
702
+ * @param {string} params.name - Key name. Max length: 128 chars.
703
+ * @param {string[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
704
+ * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
705
+ * @throws {AppwriteException}
706
+ * @returns {Promise<Models.Key>}
707
+ */
708
+ createKey(params: {
709
+ projectId: string;
710
+ name: string;
711
+ scopes?: string[];
712
+ expire?: string;
713
+ }): Promise<Models.Key>;
714
+ /**
715
+ * Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
716
+ *
717
+ * @param {string} projectId - Project unique ID.
718
+ * @param {string} name - Key name. Max length: 128 chars.
719
+ * @param {string[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
720
+ * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
721
+ * @throws {AppwriteException}
722
+ * @returns {Promise<Models.Key>}
723
+ * @deprecated Use the object parameter style method for a better developer experience.
724
+ */
725
+ createKey(projectId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
726
+ /**
727
+ * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
728
+ *
729
+ * @param {string} params.projectId - Project unique ID.
730
+ * @param {string} params.keyId - Key unique ID.
731
+ * @throws {AppwriteException}
732
+ * @returns {Promise<Models.Key>}
733
+ */
734
+ getKey(params: {
735
+ projectId: string;
736
+ keyId: string;
737
+ }): Promise<Models.Key>;
738
+ /**
739
+ * Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
740
+ *
741
+ * @param {string} projectId - Project unique ID.
742
+ * @param {string} keyId - Key unique ID.
743
+ * @throws {AppwriteException}
744
+ * @returns {Promise<Models.Key>}
745
+ * @deprecated Use the object parameter style method for a better developer experience.
746
+ */
747
+ getKey(projectId: string, keyId: string): Promise<Models.Key>;
748
+ /**
749
+ * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
750
+ *
751
+ * @param {string} params.projectId - Project unique ID.
752
+ * @param {string} params.keyId - Key unique ID.
753
+ * @param {string} params.name - Key name. Max length: 128 chars.
754
+ * @param {string[]} params.scopes - Key scopes list. Maximum of 100 events are allowed.
755
+ * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
756
+ * @throws {AppwriteException}
757
+ * @returns {Promise<Models.Key>}
758
+ */
759
+ updateKey(params: {
760
+ projectId: string;
761
+ keyId: string;
762
+ name: string;
763
+ scopes?: string[];
764
+ expire?: string;
765
+ }): Promise<Models.Key>;
766
+ /**
767
+ * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
768
+ *
769
+ * @param {string} projectId - Project unique ID.
770
+ * @param {string} keyId - Key unique ID.
771
+ * @param {string} name - Key name. Max length: 128 chars.
772
+ * @param {string[]} scopes - Key scopes list. Maximum of 100 events are allowed.
773
+ * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
774
+ * @throws {AppwriteException}
775
+ * @returns {Promise<Models.Key>}
776
+ * @deprecated Use the object parameter style method for a better developer experience.
777
+ */
778
+ updateKey(projectId: string, keyId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
779
+ /**
780
+ * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
781
+ *
782
+ * @param {string} params.projectId - Project unique ID.
783
+ * @param {string} params.keyId - Key unique ID.
784
+ * @throws {AppwriteException}
785
+ * @returns {Promise<{}>}
786
+ */
787
+ deleteKey(params: {
788
+ projectId: string;
789
+ keyId: string;
790
+ }): Promise<{}>;
791
+ /**
792
+ * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
793
+ *
794
+ * @param {string} projectId - Project unique ID.
795
+ * @param {string} keyId - Key unique ID.
796
+ * @throws {AppwriteException}
797
+ * @returns {Promise<{}>}
798
+ * @deprecated Use the object parameter style method for a better developer experience.
799
+ */
800
+ deleteKey(projectId: string, keyId: string): Promise<{}>;
801
+ /**
802
+ * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
803
+ *
804
+ * @param {string} params.projectId - Project unique ID.
805
+ * @param {OAuthProvider} params.provider - Provider Name
806
+ * @param {string} params.appId - Provider app ID. Max length: 256 chars.
807
+ * @param {string} params.secret - Provider secret key. Max length: 512 chars.
808
+ * @param {boolean} params.enabled - Provider status. Set to 'false' to disable new session creation.
809
+ * @throws {AppwriteException}
810
+ * @returns {Promise<Models.Project>}
811
+ */
812
+ updateOAuth2(params: {
813
+ projectId: string;
814
+ provider: OAuthProvider;
815
+ appId?: string;
816
+ secret?: string;
817
+ enabled?: boolean;
818
+ }): Promise<Models.Project>;
819
+ /**
820
+ * Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
821
+ *
822
+ * @param {string} projectId - Project unique ID.
823
+ * @param {OAuthProvider} provider - Provider Name
824
+ * @param {string} appId - Provider app ID. Max length: 256 chars.
825
+ * @param {string} secret - Provider secret key. Max length: 512 chars.
826
+ * @param {boolean} enabled - Provider status. Set to 'false' to disable new session creation.
827
+ * @throws {AppwriteException}
828
+ * @returns {Promise<Models.Project>}
829
+ * @deprecated Use the object parameter style method for a better developer experience.
830
+ */
831
+ updateOAuth2(projectId: string, provider: OAuthProvider, appId?: string, secret?: string, enabled?: boolean): Promise<Models.Project>;
832
+ /**
833
+ * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
834
+ *
835
+ * @param {string} params.projectId - Project unique ID.
836
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
837
+ * @throws {AppwriteException}
838
+ * @returns {Promise<Models.PlatformList>}
839
+ */
840
+ listPlatforms(params: {
841
+ projectId: string;
842
+ total?: boolean;
843
+ }): Promise<Models.PlatformList>;
844
+ /**
845
+ * Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
846
+ *
847
+ * @param {string} projectId - Project unique ID.
848
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
849
+ * @throws {AppwriteException}
850
+ * @returns {Promise<Models.PlatformList>}
851
+ * @deprecated Use the object parameter style method for a better developer experience.
852
+ */
853
+ listPlatforms(projectId: string, total?: boolean): Promise<Models.PlatformList>;
854
+ /**
855
+ * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
856
+ *
857
+ * @param {string} params.projectId - Project unique ID.
858
+ * @param {PlatformType} params.type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
859
+ * @param {string} params.name - Platform name. Max length: 128 chars.
860
+ * @param {string} params.key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
861
+ * @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
862
+ * @param {string} params.hostname - Platform client hostname. Max length: 256 chars.
863
+ * @throws {AppwriteException}
864
+ * @returns {Promise<Models.Platform>}
865
+ */
866
+ createPlatform(params: {
867
+ projectId: string;
868
+ type: PlatformType;
869
+ name: string;
870
+ key?: string;
871
+ store?: string;
872
+ hostname?: string;
873
+ }): Promise<Models.Platform>;
874
+ /**
875
+ * Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
876
+ *
877
+ * @param {string} projectId - Project unique ID.
878
+ * @param {PlatformType} type - Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
879
+ * @param {string} name - Platform name. Max length: 128 chars.
880
+ * @param {string} key - Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.
881
+ * @param {string} store - App store or Google Play store ID. Max length: 256 chars.
882
+ * @param {string} hostname - Platform client hostname. Max length: 256 chars.
883
+ * @throws {AppwriteException}
884
+ * @returns {Promise<Models.Platform>}
885
+ * @deprecated Use the object parameter style method for a better developer experience.
886
+ */
887
+ createPlatform(projectId: string, type: PlatformType, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
888
+ /**
889
+ * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
890
+ *
891
+ * @param {string} params.projectId - Project unique ID.
892
+ * @param {string} params.platformId - Platform unique ID.
893
+ * @throws {AppwriteException}
894
+ * @returns {Promise<Models.Platform>}
895
+ */
896
+ getPlatform(params: {
897
+ projectId: string;
898
+ platformId: string;
899
+ }): Promise<Models.Platform>;
900
+ /**
901
+ * Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
902
+ *
903
+ * @param {string} projectId - Project unique ID.
904
+ * @param {string} platformId - Platform unique ID.
905
+ * @throws {AppwriteException}
906
+ * @returns {Promise<Models.Platform>}
907
+ * @deprecated Use the object parameter style method for a better developer experience.
908
+ */
909
+ getPlatform(projectId: string, platformId: string): Promise<Models.Platform>;
910
+ /**
911
+ * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
912
+ *
913
+ * @param {string} params.projectId - Project unique ID.
914
+ * @param {string} params.platformId - Platform unique ID.
915
+ * @param {string} params.name - Platform name. Max length: 128 chars.
916
+ * @param {string} params.key - Package name for android or bundle ID for iOS. Max length: 256 chars.
917
+ * @param {string} params.store - App store or Google Play store ID. Max length: 256 chars.
918
+ * @param {string} params.hostname - Platform client URL. Max length: 256 chars.
919
+ * @throws {AppwriteException}
920
+ * @returns {Promise<Models.Platform>}
921
+ */
922
+ updatePlatform(params: {
923
+ projectId: string;
924
+ platformId: string;
925
+ name: string;
926
+ key?: string;
927
+ store?: string;
928
+ hostname?: string;
929
+ }): Promise<Models.Platform>;
930
+ /**
931
+ * Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
932
+ *
933
+ * @param {string} projectId - Project unique ID.
934
+ * @param {string} platformId - Platform unique ID.
935
+ * @param {string} name - Platform name. Max length: 128 chars.
936
+ * @param {string} key - Package name for android or bundle ID for iOS. Max length: 256 chars.
937
+ * @param {string} store - App store or Google Play store ID. Max length: 256 chars.
938
+ * @param {string} hostname - Platform client URL. Max length: 256 chars.
939
+ * @throws {AppwriteException}
940
+ * @returns {Promise<Models.Platform>}
941
+ * @deprecated Use the object parameter style method for a better developer experience.
942
+ */
943
+ updatePlatform(projectId: string, platformId: string, name: string, key?: string, store?: string, hostname?: string): Promise<Models.Platform>;
944
+ /**
945
+ * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
946
+ *
947
+ * @param {string} params.projectId - Project unique ID.
948
+ * @param {string} params.platformId - Platform unique ID.
949
+ * @throws {AppwriteException}
950
+ * @returns {Promise<{}>}
951
+ */
952
+ deletePlatform(params: {
953
+ projectId: string;
954
+ platformId: string;
955
+ }): Promise<{}>;
956
+ /**
957
+ * Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
958
+ *
959
+ * @param {string} projectId - Project unique ID.
960
+ * @param {string} platformId - Platform unique ID.
961
+ * @throws {AppwriteException}
962
+ * @returns {Promise<{}>}
963
+ * @deprecated Use the object parameter style method for a better developer experience.
964
+ */
965
+ deletePlatform(projectId: string, platformId: string): Promise<{}>;
966
+ /**
967
+ * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
968
+ *
969
+ * @param {string} params.projectId - Project unique ID.
970
+ * @param {ApiService} params.service - Service name.
971
+ * @param {boolean} params.status - Service status.
972
+ * @throws {AppwriteException}
973
+ * @returns {Promise<Models.Project>}
974
+ */
975
+ updateServiceStatus(params: {
976
+ projectId: string;
977
+ service: ApiService;
978
+ status: boolean;
979
+ }): Promise<Models.Project>;
980
+ /**
981
+ * Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
982
+ *
983
+ * @param {string} projectId - Project unique ID.
984
+ * @param {ApiService} service - Service name.
985
+ * @param {boolean} status - Service status.
986
+ * @throws {AppwriteException}
987
+ * @returns {Promise<Models.Project>}
988
+ * @deprecated Use the object parameter style method for a better developer experience.
989
+ */
990
+ updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project>;
991
+ /**
992
+ * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
993
+ *
994
+ * @param {string} params.projectId - Project unique ID.
995
+ * @param {boolean} params.status - Service status.
996
+ * @throws {AppwriteException}
997
+ * @returns {Promise<Models.Project>}
998
+ */
999
+ updateServiceStatusAll(params: {
1000
+ projectId: string;
1001
+ status: boolean;
1002
+ }): Promise<Models.Project>;
1003
+ /**
1004
+ * Update the status of all services. Use this endpoint to enable or disable all optional services at once.
1005
+ *
1006
+ * @param {string} projectId - Project unique ID.
1007
+ * @param {boolean} status - Service status.
1008
+ * @throws {AppwriteException}
1009
+ * @returns {Promise<Models.Project>}
1010
+ * @deprecated Use the object parameter style method for a better developer experience.
1011
+ */
1012
+ updateServiceStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
1013
+ /**
1014
+ * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
1015
+ *
1016
+ * @param {string} params.projectId - Project unique ID.
1017
+ * @param {boolean} params.enabled - Enable custom SMTP service
1018
+ * @param {string} params.senderName - Name of the email sender
1019
+ * @param {string} params.senderEmail - Email of the sender
1020
+ * @param {string} params.replyTo - Reply to email
1021
+ * @param {string} params.host - SMTP server host name
1022
+ * @param {number} params.port - SMTP server port
1023
+ * @param {string} params.username - SMTP server username
1024
+ * @param {string} params.password - SMTP server password
1025
+ * @param {SMTPSecure} params.secure - Does SMTP server use secure connection
1026
+ * @throws {AppwriteException}
1027
+ * @returns {Promise<Models.Project>}
1028
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMTP` instead.
1029
+ */
1030
+ updateSmtp(params: {
1031
+ projectId: string;
1032
+ enabled: boolean;
1033
+ senderName?: string;
1034
+ senderEmail?: string;
1035
+ replyTo?: string;
1036
+ host?: string;
1037
+ port?: number;
1038
+ username?: string;
1039
+ password?: string;
1040
+ secure?: SMTPSecure;
1041
+ }): Promise<Models.Project>;
1042
+ /**
1043
+ * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
1044
+ *
1045
+ * @param {string} projectId - Project unique ID.
1046
+ * @param {boolean} enabled - Enable custom SMTP service
1047
+ * @param {string} senderName - Name of the email sender
1048
+ * @param {string} senderEmail - Email of the sender
1049
+ * @param {string} replyTo - Reply to email
1050
+ * @param {string} host - SMTP server host name
1051
+ * @param {number} port - SMTP server port
1052
+ * @param {string} username - SMTP server username
1053
+ * @param {string} password - SMTP server password
1054
+ * @param {SMTPSecure} secure - Does SMTP server use secure connection
1055
+ * @throws {AppwriteException}
1056
+ * @returns {Promise<Models.Project>}
1057
+ * @deprecated Use the object parameter style method for a better developer experience.
1058
+ */
1059
+ updateSmtp(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
1060
+ /**
1061
+ * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
1062
+ *
1063
+ * @param {string} params.projectId - Project unique ID.
1064
+ * @param {boolean} params.enabled - Enable custom SMTP service
1065
+ * @param {string} params.senderName - Name of the email sender
1066
+ * @param {string} params.senderEmail - Email of the sender
1067
+ * @param {string} params.replyTo - Reply to email
1068
+ * @param {string} params.host - SMTP server host name
1069
+ * @param {number} params.port - SMTP server port
1070
+ * @param {string} params.username - SMTP server username
1071
+ * @param {string} params.password - SMTP server password
1072
+ * @param {SMTPSecure} params.secure - Does SMTP server use secure connection
1073
+ * @throws {AppwriteException}
1074
+ * @returns {Promise<Models.Project>}
1075
+ */
1076
+ updateSMTP(params: {
1077
+ projectId: string;
1078
+ enabled: boolean;
1079
+ senderName?: string;
1080
+ senderEmail?: string;
1081
+ replyTo?: string;
1082
+ host?: string;
1083
+ port?: number;
1084
+ username?: string;
1085
+ password?: string;
1086
+ secure?: SMTPSecure;
1087
+ }): Promise<Models.Project>;
1088
+ /**
1089
+ * Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
1090
+ *
1091
+ * @param {string} projectId - Project unique ID.
1092
+ * @param {boolean} enabled - Enable custom SMTP service
1093
+ * @param {string} senderName - Name of the email sender
1094
+ * @param {string} senderEmail - Email of the sender
1095
+ * @param {string} replyTo - Reply to email
1096
+ * @param {string} host - SMTP server host name
1097
+ * @param {number} port - SMTP server port
1098
+ * @param {string} username - SMTP server username
1099
+ * @param {string} password - SMTP server password
1100
+ * @param {SMTPSecure} secure - Does SMTP server use secure connection
1101
+ * @throws {AppwriteException}
1102
+ * @returns {Promise<Models.Project>}
1103
+ * @deprecated Use the object parameter style method for a better developer experience.
1104
+ */
1105
+ updateSMTP(projectId: string, enabled: boolean, senderName?: string, senderEmail?: string, replyTo?: string, host?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<Models.Project>;
1106
+ /**
1107
+ * Send a test email to verify SMTP configuration.
1108
+ *
1109
+ * @param {string} params.projectId - Project unique ID.
1110
+ * @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
1111
+ * @param {string} params.senderName - Name of the email sender
1112
+ * @param {string} params.senderEmail - Email of the sender
1113
+ * @param {string} params.host - SMTP server host name
1114
+ * @param {string} params.replyTo - Reply to email
1115
+ * @param {number} params.port - SMTP server port
1116
+ * @param {string} params.username - SMTP server username
1117
+ * @param {string} params.password - SMTP server password
1118
+ * @param {SMTPSecure} params.secure - Does SMTP server use secure connection
1119
+ * @throws {AppwriteException}
1120
+ * @returns {Promise<{}>}
1121
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.createSMTPTest` instead.
1122
+ */
1123
+ createSmtpTest(params: {
1124
+ projectId: string;
1125
+ emails: string[];
1126
+ senderName: string;
1127
+ senderEmail: string;
1128
+ host: string;
1129
+ replyTo?: string;
1130
+ port?: number;
1131
+ username?: string;
1132
+ password?: string;
1133
+ secure?: SMTPSecure;
1134
+ }): Promise<{}>;
1135
+ /**
1136
+ * Send a test email to verify SMTP configuration.
1137
+ *
1138
+ * @param {string} projectId - Project unique ID.
1139
+ * @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
1140
+ * @param {string} senderName - Name of the email sender
1141
+ * @param {string} senderEmail - Email of the sender
1142
+ * @param {string} host - SMTP server host name
1143
+ * @param {string} replyTo - Reply to email
1144
+ * @param {number} port - SMTP server port
1145
+ * @param {string} username - SMTP server username
1146
+ * @param {string} password - SMTP server password
1147
+ * @param {SMTPSecure} secure - Does SMTP server use secure connection
1148
+ * @throws {AppwriteException}
1149
+ * @returns {Promise<{}>}
1150
+ * @deprecated Use the object parameter style method for a better developer experience.
1151
+ */
1152
+ createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
1153
+ /**
1154
+ * Send a test email to verify SMTP configuration.
1155
+ *
1156
+ * @param {string} params.projectId - Project unique ID.
1157
+ * @param {string[]} params.emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
1158
+ * @param {string} params.senderName - Name of the email sender
1159
+ * @param {string} params.senderEmail - Email of the sender
1160
+ * @param {string} params.host - SMTP server host name
1161
+ * @param {string} params.replyTo - Reply to email
1162
+ * @param {number} params.port - SMTP server port
1163
+ * @param {string} params.username - SMTP server username
1164
+ * @param {string} params.password - SMTP server password
1165
+ * @param {SMTPSecure} params.secure - Does SMTP server use secure connection
1166
+ * @throws {AppwriteException}
1167
+ * @returns {Promise<{}>}
1168
+ */
1169
+ createSMTPTest(params: {
1170
+ projectId: string;
1171
+ emails: string[];
1172
+ senderName: string;
1173
+ senderEmail: string;
1174
+ host: string;
1175
+ replyTo?: string;
1176
+ port?: number;
1177
+ username?: string;
1178
+ password?: string;
1179
+ secure?: SMTPSecure;
1180
+ }): Promise<{}>;
1181
+ /**
1182
+ * Send a test email to verify SMTP configuration.
1183
+ *
1184
+ * @param {string} projectId - Project unique ID.
1185
+ * @param {string[]} emails - Array of emails to send test email to. Maximum of 10 emails are allowed.
1186
+ * @param {string} senderName - Name of the email sender
1187
+ * @param {string} senderEmail - Email of the sender
1188
+ * @param {string} host - SMTP server host name
1189
+ * @param {string} replyTo - Reply to email
1190
+ * @param {number} port - SMTP server port
1191
+ * @param {string} username - SMTP server username
1192
+ * @param {string} password - SMTP server password
1193
+ * @param {SMTPSecure} secure - Does SMTP server use secure connection
1194
+ * @throws {AppwriteException}
1195
+ * @returns {Promise<{}>}
1196
+ * @deprecated Use the object parameter style method for a better developer experience.
1197
+ */
1198
+ createSMTPTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
1199
+ /**
1200
+ * Update the status of a project
1201
+ *
1202
+ * @param {string} params.projectId - Project ID
1203
+ * @param {Status} params.status - New status for the project
1204
+ * @throws {AppwriteException}
1205
+ * @returns {Promise<{}>}
1206
+ */
1207
+ updateStatus(params: {
1208
+ projectId: string;
1209
+ status: Status;
1210
+ }): Promise<{}>;
1211
+ /**
1212
+ * Update the status of a project
1213
+ *
1214
+ * @param {string} projectId - Project ID
1215
+ * @param {Status} status - New status for the project
1216
+ * @throws {AppwriteException}
1217
+ * @returns {Promise<{}>}
1218
+ * @deprecated Use the object parameter style method for a better developer experience.
1219
+ */
1220
+ updateStatus(projectId: string, status: Status): Promise<{}>;
1221
+ /**
1222
+ * Update the team ID of a project allowing for it to be transferred to another team.
1223
+ *
1224
+ * @param {string} params.projectId - Project unique ID.
1225
+ * @param {string} params.teamId - Team ID of the team to transfer project to.
1226
+ * @throws {AppwriteException}
1227
+ * @returns {Promise<Models.Project>}
1228
+ */
1229
+ updateTeam(params: {
1230
+ projectId: string;
1231
+ teamId: string;
1232
+ }): Promise<Models.Project>;
1233
+ /**
1234
+ * Update the team ID of a project allowing for it to be transferred to another team.
1235
+ *
1236
+ * @param {string} projectId - Project unique ID.
1237
+ * @param {string} teamId - Team ID of the team to transfer project to.
1238
+ * @throws {AppwriteException}
1239
+ * @returns {Promise<Models.Project>}
1240
+ * @deprecated Use the object parameter style method for a better developer experience.
1241
+ */
1242
+ updateTeam(projectId: string, teamId: string): Promise<Models.Project>;
1243
+ /**
1244
+ * Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
1245
+ *
1246
+ * @param {string} params.projectId - Project unique ID.
1247
+ * @param {EmailTemplateType} params.type - Template type
1248
+ * @param {EmailTemplateLocale} params.locale - Template locale
1249
+ * @throws {AppwriteException}
1250
+ * @returns {Promise<Models.EmailTemplate>}
1251
+ */
1252
+ getEmailTemplate(params: {
1253
+ projectId: string;
1254
+ type: EmailTemplateType;
1255
+ locale: EmailTemplateLocale;
1256
+ }): Promise<Models.EmailTemplate>;
1257
+ /**
1258
+ * Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
1259
+ *
1260
+ * @param {string} projectId - Project unique ID.
1261
+ * @param {EmailTemplateType} type - Template type
1262
+ * @param {EmailTemplateLocale} locale - Template locale
1263
+ * @throws {AppwriteException}
1264
+ * @returns {Promise<Models.EmailTemplate>}
1265
+ * @deprecated Use the object parameter style method for a better developer experience.
1266
+ */
1267
+ getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
1268
+ /**
1269
+ * Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
1270
+ *
1271
+ * @param {string} params.projectId - Project unique ID.
1272
+ * @param {EmailTemplateType} params.type - Template type
1273
+ * @param {EmailTemplateLocale} params.locale - Template locale
1274
+ * @param {string} params.subject - Email Subject
1275
+ * @param {string} params.message - Template message
1276
+ * @param {string} params.senderName - Name of the email sender
1277
+ * @param {string} params.senderEmail - Email of the sender
1278
+ * @param {string} params.replyTo - Reply to email
1279
+ * @throws {AppwriteException}
1280
+ * @returns {Promise<Models.EmailTemplate>}
1281
+ */
1282
+ updateEmailTemplate(params: {
1283
+ projectId: string;
1284
+ type: EmailTemplateType;
1285
+ locale: EmailTemplateLocale;
1286
+ subject: string;
1287
+ message: string;
1288
+ senderName?: string;
1289
+ senderEmail?: string;
1290
+ replyTo?: string;
1291
+ }): Promise<Models.EmailTemplate>;
1292
+ /**
1293
+ * Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
1294
+ *
1295
+ * @param {string} projectId - Project unique ID.
1296
+ * @param {EmailTemplateType} type - Template type
1297
+ * @param {EmailTemplateLocale} locale - Template locale
1298
+ * @param {string} subject - Email Subject
1299
+ * @param {string} message - Template message
1300
+ * @param {string} senderName - Name of the email sender
1301
+ * @param {string} senderEmail - Email of the sender
1302
+ * @param {string} replyTo - Reply to email
1303
+ * @throws {AppwriteException}
1304
+ * @returns {Promise<Models.EmailTemplate>}
1305
+ * @deprecated Use the object parameter style method for a better developer experience.
1306
+ */
1307
+ updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.EmailTemplate>;
1308
+ /**
1309
+ * Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
1310
+ *
1311
+ * @param {string} params.projectId - Project unique ID.
1312
+ * @param {EmailTemplateType} params.type - Template type
1313
+ * @param {EmailTemplateLocale} params.locale - Template locale
1314
+ * @throws {AppwriteException}
1315
+ * @returns {Promise<Models.EmailTemplate>}
1316
+ */
1317
+ deleteEmailTemplate(params: {
1318
+ projectId: string;
1319
+ type: EmailTemplateType;
1320
+ locale: EmailTemplateLocale;
1321
+ }): Promise<Models.EmailTemplate>;
1322
+ /**
1323
+ * Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
1324
+ *
1325
+ * @param {string} projectId - Project unique ID.
1326
+ * @param {EmailTemplateType} type - Template type
1327
+ * @param {EmailTemplateLocale} locale - Template locale
1328
+ * @throws {AppwriteException}
1329
+ * @returns {Promise<Models.EmailTemplate>}
1330
+ * @deprecated Use the object parameter style method for a better developer experience.
1331
+ */
1332
+ deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
1333
+ /**
1334
+ * Get a custom SMS template for the specified locale and type returning it's contents.
1335
+ *
1336
+ * @param {string} params.projectId - Project unique ID.
1337
+ * @param {SmsTemplateType} params.type - Template type
1338
+ * @param {SmsTemplateLocale} params.locale - Template locale
1339
+ * @throws {AppwriteException}
1340
+ * @returns {Promise<Models.SmsTemplate>}
1341
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.getSMSTemplate` instead.
1342
+ */
1343
+ getSmsTemplate(params: {
1344
+ projectId: string;
1345
+ type: SmsTemplateType;
1346
+ locale: SmsTemplateLocale;
1347
+ }): Promise<Models.SmsTemplate>;
1348
+ /**
1349
+ * Get a custom SMS template for the specified locale and type returning it's contents.
1350
+ *
1351
+ * @param {string} projectId - Project unique ID.
1352
+ * @param {SmsTemplateType} type - Template type
1353
+ * @param {SmsTemplateLocale} locale - Template locale
1354
+ * @throws {AppwriteException}
1355
+ * @returns {Promise<Models.SmsTemplate>}
1356
+ * @deprecated Use the object parameter style method for a better developer experience.
1357
+ */
1358
+ getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
1359
+ /**
1360
+ * Get a custom SMS template for the specified locale and type returning it's contents.
1361
+ *
1362
+ * @param {string} params.projectId - Project unique ID.
1363
+ * @param {SmsTemplateType} params.type - Template type
1364
+ * @param {SmsTemplateLocale} params.locale - Template locale
1365
+ * @throws {AppwriteException}
1366
+ * @returns {Promise<Models.SmsTemplate>}
1367
+ */
1368
+ getSMSTemplate(params: {
1369
+ projectId: string;
1370
+ type: SmsTemplateType;
1371
+ locale: SmsTemplateLocale;
1372
+ }): Promise<Models.SmsTemplate>;
1373
+ /**
1374
+ * Get a custom SMS template for the specified locale and type returning it's contents.
1375
+ *
1376
+ * @param {string} projectId - Project unique ID.
1377
+ * @param {SmsTemplateType} type - Template type
1378
+ * @param {SmsTemplateLocale} locale - Template locale
1379
+ * @throws {AppwriteException}
1380
+ * @returns {Promise<Models.SmsTemplate>}
1381
+ * @deprecated Use the object parameter style method for a better developer experience.
1382
+ */
1383
+ getSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
1384
+ /**
1385
+ * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
1386
+ *
1387
+ * @param {string} params.projectId - Project unique ID.
1388
+ * @param {SmsTemplateType} params.type - Template type
1389
+ * @param {SmsTemplateLocale} params.locale - Template locale
1390
+ * @param {string} params.message - Template message
1391
+ * @throws {AppwriteException}
1392
+ * @returns {Promise<Models.SmsTemplate>}
1393
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.updateSMSTemplate` instead.
1394
+ */
1395
+ updateSmsTemplate(params: {
1396
+ projectId: string;
1397
+ type: SmsTemplateType;
1398
+ locale: SmsTemplateLocale;
1399
+ message: string;
1400
+ }): Promise<Models.SmsTemplate>;
1401
+ /**
1402
+ * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
1403
+ *
1404
+ * @param {string} projectId - Project unique ID.
1405
+ * @param {SmsTemplateType} type - Template type
1406
+ * @param {SmsTemplateLocale} locale - Template locale
1407
+ * @param {string} message - Template message
1408
+ * @throws {AppwriteException}
1409
+ * @returns {Promise<Models.SmsTemplate>}
1410
+ * @deprecated Use the object parameter style method for a better developer experience.
1411
+ */
1412
+ updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
1413
+ /**
1414
+ * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
1415
+ *
1416
+ * @param {string} params.projectId - Project unique ID.
1417
+ * @param {SmsTemplateType} params.type - Template type
1418
+ * @param {SmsTemplateLocale} params.locale - Template locale
1419
+ * @param {string} params.message - Template message
1420
+ * @throws {AppwriteException}
1421
+ * @returns {Promise<Models.SmsTemplate>}
1422
+ */
1423
+ updateSMSTemplate(params: {
1424
+ projectId: string;
1425
+ type: SmsTemplateType;
1426
+ locale: SmsTemplateLocale;
1427
+ message: string;
1428
+ }): Promise<Models.SmsTemplate>;
1429
+ /**
1430
+ * Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
1431
+ *
1432
+ * @param {string} projectId - Project unique ID.
1433
+ * @param {SmsTemplateType} type - Template type
1434
+ * @param {SmsTemplateLocale} locale - Template locale
1435
+ * @param {string} message - Template message
1436
+ * @throws {AppwriteException}
1437
+ * @returns {Promise<Models.SmsTemplate>}
1438
+ * @deprecated Use the object parameter style method for a better developer experience.
1439
+ */
1440
+ updateSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
1441
+ /**
1442
+ * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
1443
+ *
1444
+ * @param {string} params.projectId - Project unique ID.
1445
+ * @param {SmsTemplateType} params.type - Template type
1446
+ * @param {SmsTemplateLocale} params.locale - Template locale
1447
+ * @throws {AppwriteException}
1448
+ * @returns {Promise<Models.SmsTemplate>}
1449
+ * @deprecated This API has been deprecated since 1.8.0. Please use `Projects.deleteSMSTemplate` instead.
1450
+ */
1451
+ deleteSmsTemplate(params: {
1452
+ projectId: string;
1453
+ type: SmsTemplateType;
1454
+ locale: SmsTemplateLocale;
1455
+ }): Promise<Models.SmsTemplate>;
1456
+ /**
1457
+ * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
1458
+ *
1459
+ * @param {string} projectId - Project unique ID.
1460
+ * @param {SmsTemplateType} type - Template type
1461
+ * @param {SmsTemplateLocale} locale - Template locale
1462
+ * @throws {AppwriteException}
1463
+ * @returns {Promise<Models.SmsTemplate>}
1464
+ * @deprecated Use the object parameter style method for a better developer experience.
1465
+ */
1466
+ deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
1467
+ /**
1468
+ * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
1469
+ *
1470
+ * @param {string} params.projectId - Project unique ID.
1471
+ * @param {SmsTemplateType} params.type - Template type
1472
+ * @param {SmsTemplateLocale} params.locale - Template locale
1473
+ * @throws {AppwriteException}
1474
+ * @returns {Promise<Models.SmsTemplate>}
1475
+ */
1476
+ deleteSMSTemplate(params: {
1477
+ projectId: string;
1478
+ type: SmsTemplateType;
1479
+ locale: SmsTemplateLocale;
1480
+ }): Promise<Models.SmsTemplate>;
1481
+ /**
1482
+ * Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
1483
+ *
1484
+ * @param {string} projectId - Project unique ID.
1485
+ * @param {SmsTemplateType} type - Template type
1486
+ * @param {SmsTemplateLocale} locale - Template locale
1487
+ * @throws {AppwriteException}
1488
+ * @returns {Promise<Models.SmsTemplate>}
1489
+ * @deprecated Use the object parameter style method for a better developer experience.
1490
+ */
1491
+ deleteSMSTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
1492
+ /**
1493
+ * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
1494
+ *
1495
+ * @param {string} params.projectId - Project unique ID.
1496
+ * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
1497
+ * @throws {AppwriteException}
1498
+ * @returns {Promise<Models.WebhookList>}
1499
+ */
1500
+ listWebhooks(params: {
1501
+ projectId: string;
1502
+ total?: boolean;
1503
+ }): Promise<Models.WebhookList>;
1504
+ /**
1505
+ * Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
1506
+ *
1507
+ * @param {string} projectId - Project unique ID.
1508
+ * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
1509
+ * @throws {AppwriteException}
1510
+ * @returns {Promise<Models.WebhookList>}
1511
+ * @deprecated Use the object parameter style method for a better developer experience.
1512
+ */
1513
+ listWebhooks(projectId: string, total?: boolean): Promise<Models.WebhookList>;
1514
+ /**
1515
+ * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
1516
+ *
1517
+ * @param {string} params.projectId - Project unique ID.
1518
+ * @param {string} params.name - Webhook name. Max length: 128 chars.
1519
+ * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
1520
+ * @param {string} params.url - Webhook URL.
1521
+ * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
1522
+ * @param {boolean} params.enabled - Enable or disable a webhook.
1523
+ * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
1524
+ * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
1525
+ * @throws {AppwriteException}
1526
+ * @returns {Promise<Models.Webhook>}
1527
+ */
1528
+ createWebhook(params: {
1529
+ projectId: string;
1530
+ name: string;
1531
+ events: string[];
1532
+ url: string;
1533
+ security: boolean;
1534
+ enabled?: boolean;
1535
+ httpUser?: string;
1536
+ httpPass?: string;
1537
+ }): Promise<Models.Webhook>;
1538
+ /**
1539
+ * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
1540
+ *
1541
+ * @param {string} projectId - Project unique ID.
1542
+ * @param {string} name - Webhook name. Max length: 128 chars.
1543
+ * @param {string[]} events - Events list. Maximum of 100 events are allowed.
1544
+ * @param {string} url - Webhook URL.
1545
+ * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
1546
+ * @param {boolean} enabled - Enable or disable a webhook.
1547
+ * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
1548
+ * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
1549
+ * @throws {AppwriteException}
1550
+ * @returns {Promise<Models.Webhook>}
1551
+ * @deprecated Use the object parameter style method for a better developer experience.
1552
+ */
1553
+ createWebhook(projectId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
1554
+ /**
1555
+ * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
1556
+ *
1557
+ * @param {string} params.projectId - Project unique ID.
1558
+ * @param {string} params.webhookId - Webhook unique ID.
1559
+ * @throws {AppwriteException}
1560
+ * @returns {Promise<Models.Webhook>}
1561
+ */
1562
+ getWebhook(params: {
1563
+ projectId: string;
1564
+ webhookId: string;
1565
+ }): Promise<Models.Webhook>;
1566
+ /**
1567
+ * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
1568
+ *
1569
+ * @param {string} projectId - Project unique ID.
1570
+ * @param {string} webhookId - Webhook unique ID.
1571
+ * @throws {AppwriteException}
1572
+ * @returns {Promise<Models.Webhook>}
1573
+ * @deprecated Use the object parameter style method for a better developer experience.
1574
+ */
1575
+ getWebhook(projectId: string, webhookId: string): Promise<Models.Webhook>;
1576
+ /**
1577
+ * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
1578
+ *
1579
+ * @param {string} params.projectId - Project unique ID.
1580
+ * @param {string} params.webhookId - Webhook unique ID.
1581
+ * @param {string} params.name - Webhook name. Max length: 128 chars.
1582
+ * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
1583
+ * @param {string} params.url - Webhook URL.
1584
+ * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
1585
+ * @param {boolean} params.enabled - Enable or disable a webhook.
1586
+ * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
1587
+ * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
1588
+ * @throws {AppwriteException}
1589
+ * @returns {Promise<Models.Webhook>}
1590
+ */
1591
+ updateWebhook(params: {
1592
+ projectId: string;
1593
+ webhookId: string;
1594
+ name: string;
1595
+ events: string[];
1596
+ url: string;
1597
+ security: boolean;
1598
+ enabled?: boolean;
1599
+ httpUser?: string;
1600
+ httpPass?: string;
1601
+ }): Promise<Models.Webhook>;
1602
+ /**
1603
+ * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
1604
+ *
1605
+ * @param {string} projectId - Project unique ID.
1606
+ * @param {string} webhookId - Webhook unique ID.
1607
+ * @param {string} name - Webhook name. Max length: 128 chars.
1608
+ * @param {string[]} events - Events list. Maximum of 100 events are allowed.
1609
+ * @param {string} url - Webhook URL.
1610
+ * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
1611
+ * @param {boolean} enabled - Enable or disable a webhook.
1612
+ * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
1613
+ * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
1614
+ * @throws {AppwriteException}
1615
+ * @returns {Promise<Models.Webhook>}
1616
+ * @deprecated Use the object parameter style method for a better developer experience.
1617
+ */
1618
+ updateWebhook(projectId: string, webhookId: string, name: string, events: string[], url: string, security: boolean, enabled?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
1619
+ /**
1620
+ * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
1621
+ *
1622
+ * @param {string} params.projectId - Project unique ID.
1623
+ * @param {string} params.webhookId - Webhook unique ID.
1624
+ * @throws {AppwriteException}
1625
+ * @returns {Promise<{}>}
1626
+ */
1627
+ deleteWebhook(params: {
1628
+ projectId: string;
1629
+ webhookId: string;
1630
+ }): Promise<{}>;
1631
+ /**
1632
+ * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
1633
+ *
1634
+ * @param {string} projectId - Project unique ID.
1635
+ * @param {string} webhookId - Webhook unique ID.
1636
+ * @throws {AppwriteException}
1637
+ * @returns {Promise<{}>}
1638
+ * @deprecated Use the object parameter style method for a better developer experience.
1639
+ */
1640
+ deleteWebhook(projectId: string, webhookId: string): Promise<{}>;
1641
+ /**
1642
+ * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
1643
+ *
1644
+ * @param {string} params.projectId - Project unique ID.
1645
+ * @param {string} params.webhookId - Webhook unique ID.
1646
+ * @throws {AppwriteException}
1647
+ * @returns {Promise<Models.Webhook>}
1648
+ */
1649
+ updateWebhookSignature(params: {
1650
+ projectId: string;
1651
+ webhookId: string;
1652
+ }): Promise<Models.Webhook>;
1653
+ /**
1654
+ * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
1655
+ *
1656
+ * @param {string} projectId - Project unique ID.
1657
+ * @param {string} webhookId - Webhook unique ID.
1658
+ * @throws {AppwriteException}
1659
+ * @returns {Promise<Models.Webhook>}
1660
+ * @deprecated Use the object parameter style method for a better developer experience.
1661
+ */
1662
+ updateWebhookSignature(projectId: string, webhookId: string): Promise<Models.Webhook>;
1663
+ }