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