@appwrite.io/console 1.5.2 → 1.6.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 (53) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/sdk.js +7673 -9723
  3. package/dist/cjs/sdk.js.map +1 -1
  4. package/dist/esm/sdk.js +7673 -9723
  5. package/dist/esm/sdk.js.map +1 -1
  6. package/dist/iife/sdk.js +7673 -9723
  7. package/docs/examples/organizations/validate-invoice.md +14 -0
  8. package/package.json +1 -1
  9. package/src/client.ts +21 -4
  10. package/src/enums/o-auth-provider.ts +1 -0
  11. package/src/models.ts +118 -6
  12. package/src/services/account.ts +126 -430
  13. package/src/services/assistant.ts +2 -7
  14. package/src/services/avatars.ts +7 -21
  15. package/src/services/backups.ts +24 -84
  16. package/src/services/console.ts +14 -49
  17. package/src/services/databases.ts +96 -336
  18. package/src/services/functions.ts +55 -192
  19. package/src/services/graphql.ts +4 -14
  20. package/src/services/health.ts +50 -175
  21. package/src/services/locale.ts +16 -56
  22. package/src/services/messaging.ts +92 -322
  23. package/src/services/migrations.ts +24 -84
  24. package/src/services/organizations.ts +86 -196
  25. package/src/services/project.ts +12 -42
  26. package/src/services/projects.ts +92 -322
  27. package/src/services/proxy.ts +10 -35
  28. package/src/services/storage.ts +27 -93
  29. package/src/services/teams.ts +28 -98
  30. package/src/services/users.ts +86 -301
  31. package/src/services/vcs.ts +20 -70
  32. package/types/enums/o-auth-provider.d.ts +1 -0
  33. package/types/models.d.ts +118 -6
  34. package/types/services/account.d.ts +4 -128
  35. package/types/services/assistant.d.ts +0 -2
  36. package/types/services/avatars.d.ts +0 -14
  37. package/types/services/backups.d.ts +0 -24
  38. package/types/services/console.d.ts +0 -14
  39. package/types/services/databases.d.ts +0 -96
  40. package/types/services/functions.d.ts +0 -56
  41. package/types/services/graphql.d.ts +0 -4
  42. package/types/services/health.d.ts +0 -50
  43. package/types/services/locale.d.ts +0 -16
  44. package/types/services/messaging.d.ts +0 -92
  45. package/types/services/migrations.d.ts +0 -24
  46. package/types/services/organizations.d.ts +11 -58
  47. package/types/services/project.d.ts +0 -12
  48. package/types/services/projects.d.ts +0 -92
  49. package/types/services/proxy.d.ts +0 -10
  50. package/types/services/storage.d.ts +0 -30
  51. package/types/services/teams.d.ts +0 -28
  52. package/types/services/users.d.ts +0 -86
  53. package/types/services/vcs.d.ts +0 -20
@@ -10,8 +10,6 @@ export class Vcs {
10
10
  }
11
11
 
12
12
  /**
13
- * List repositories
14
- *
15
13
  * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
16
14
  *
17
15
  * @param {string} installationId
@@ -19,7 +17,7 @@ export class Vcs {
19
17
  * @throws {AppwriteException}
20
18
  * @returns {Promise<Models.ProviderRepositoryList>}
21
19
  */
22
- async listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList> {
20
+ listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList> {
23
21
  if (typeof installationId === 'undefined') {
24
22
  throw new AppwriteException('Missing required parameter: "installationId"');
25
23
  }
@@ -34,10 +32,7 @@ export class Vcs {
34
32
  'content-type': 'application/json',
35
33
  }
36
34
 
37
- payload['project'] = this.client.config.project;
38
-
39
-
40
- return await this.client.call(
35
+ return this.client.call(
41
36
  'get',
42
37
  uri,
43
38
  apiHeaders,
@@ -45,8 +40,6 @@ export class Vcs {
45
40
  );
46
41
  }
47
42
  /**
48
- * Create repository
49
- *
50
43
  * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
51
44
  *
52
45
  * @param {string} installationId
@@ -55,7 +48,7 @@ export class Vcs {
55
48
  * @throws {AppwriteException}
56
49
  * @returns {Promise<Models.ProviderRepository>}
57
50
  */
58
- async createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository> {
51
+ createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository> {
59
52
  if (typeof installationId === 'undefined') {
60
53
  throw new AppwriteException('Missing required parameter: "installationId"');
61
54
  }
@@ -79,10 +72,7 @@ export class Vcs {
79
72
  'content-type': 'application/json',
80
73
  }
81
74
 
82
- payload['project'] = this.client.config.project;
83
-
84
-
85
- return await this.client.call(
75
+ return this.client.call(
86
76
  'post',
87
77
  uri,
88
78
  apiHeaders,
@@ -90,8 +80,6 @@ export class Vcs {
90
80
  );
91
81
  }
92
82
  /**
93
- * Get repository
94
- *
95
83
  * Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
96
84
  *
97
85
  * @param {string} installationId
@@ -99,7 +87,7 @@ export class Vcs {
99
87
  * @throws {AppwriteException}
100
88
  * @returns {Promise<Models.ProviderRepository>}
101
89
  */
102
- async getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository> {
90
+ getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository> {
103
91
  if (typeof installationId === 'undefined') {
104
92
  throw new AppwriteException('Missing required parameter: "installationId"');
105
93
  }
@@ -114,10 +102,7 @@ export class Vcs {
114
102
  'content-type': 'application/json',
115
103
  }
116
104
 
117
- payload['project'] = this.client.config.project;
118
-
119
-
120
- return await this.client.call(
105
+ return this.client.call(
121
106
  'get',
122
107
  uri,
123
108
  apiHeaders,
@@ -125,8 +110,6 @@ export class Vcs {
125
110
  );
126
111
  }
127
112
  /**
128
- * List repository branches
129
- *
130
113
  * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
131
114
 
132
115
  *
@@ -135,7 +118,7 @@ export class Vcs {
135
118
  * @throws {AppwriteException}
136
119
  * @returns {Promise<Models.BranchList>}
137
120
  */
138
- async listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList> {
121
+ listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList> {
139
122
  if (typeof installationId === 'undefined') {
140
123
  throw new AppwriteException('Missing required parameter: "installationId"');
141
124
  }
@@ -150,10 +133,7 @@ export class Vcs {
150
133
  'content-type': 'application/json',
151
134
  }
152
135
 
153
- payload['project'] = this.client.config.project;
154
-
155
-
156
- return await this.client.call(
136
+ return this.client.call(
157
137
  'get',
158
138
  uri,
159
139
  apiHeaders,
@@ -161,8 +141,6 @@ export class Vcs {
161
141
  );
162
142
  }
163
143
  /**
164
- * Get files and directories of a VCS repository
165
- *
166
144
  * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
167
145
 
168
146
  *
@@ -172,7 +150,7 @@ export class Vcs {
172
150
  * @throws {AppwriteException}
173
151
  * @returns {Promise<Models.VcsContentList>}
174
152
  */
175
- async getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList> {
153
+ getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList> {
176
154
  if (typeof installationId === 'undefined') {
177
155
  throw new AppwriteException('Missing required parameter: "installationId"');
178
156
  }
@@ -190,10 +168,7 @@ export class Vcs {
190
168
  'content-type': 'application/json',
191
169
  }
192
170
 
193
- payload['project'] = this.client.config.project;
194
-
195
-
196
- return await this.client.call(
171
+ return this.client.call(
197
172
  'get',
198
173
  uri,
199
174
  apiHeaders,
@@ -201,8 +176,6 @@ export class Vcs {
201
176
  );
202
177
  }
203
178
  /**
204
- * Detect runtime settings from source code
205
- *
206
179
  * Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository&#039;s files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
207
180
  *
208
181
  * @param {string} installationId
@@ -211,7 +184,7 @@ export class Vcs {
211
184
  * @throws {AppwriteException}
212
185
  * @returns {Promise<Models.Detection>}
213
186
  */
214
- async createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection> {
187
+ createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection> {
215
188
  if (typeof installationId === 'undefined') {
216
189
  throw new AppwriteException('Missing required parameter: "installationId"');
217
190
  }
@@ -229,10 +202,7 @@ export class Vcs {
229
202
  'content-type': 'application/json',
230
203
  }
231
204
 
232
- payload['project'] = this.client.config.project;
233
-
234
-
235
- return await this.client.call(
205
+ return this.client.call(
236
206
  'post',
237
207
  uri,
238
208
  apiHeaders,
@@ -240,8 +210,6 @@ export class Vcs {
240
210
  );
241
211
  }
242
212
  /**
243
- * Authorize external deployment
244
- *
245
213
  * Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.
246
214
  *
247
215
  * @param {string} installationId
@@ -250,7 +218,7 @@ export class Vcs {
250
218
  * @throws {AppwriteException}
251
219
  * @returns {Promise<{}>}
252
220
  */
253
- async updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}> {
221
+ updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}> {
254
222
  if (typeof installationId === 'undefined') {
255
223
  throw new AppwriteException('Missing required parameter: "installationId"');
256
224
  }
@@ -271,10 +239,7 @@ export class Vcs {
271
239
  'content-type': 'application/json',
272
240
  }
273
241
 
274
- payload['project'] = this.client.config.project;
275
-
276
-
277
- return await this.client.call(
242
+ return this.client.call(
278
243
  'patch',
279
244
  uri,
280
245
  apiHeaders,
@@ -282,8 +247,6 @@ export class Vcs {
282
247
  );
283
248
  }
284
249
  /**
285
- * List installations
286
- *
287
250
  * List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
288
251
 
289
252
  *
@@ -292,7 +255,7 @@ export class Vcs {
292
255
  * @throws {AppwriteException}
293
256
  * @returns {Promise<Models.InstallationList>}
294
257
  */
295
- async listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList> {
258
+ listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList> {
296
259
  const apiPath = '/vcs/installations';
297
260
  const payload: Payload = {};
298
261
  if (typeof queries !== 'undefined') {
@@ -307,10 +270,7 @@ export class Vcs {
307
270
  'content-type': 'application/json',
308
271
  }
309
272
 
310
- payload['project'] = this.client.config.project;
311
-
312
-
313
- return await this.client.call(
273
+ return this.client.call(
314
274
  'get',
315
275
  uri,
316
276
  apiHeaders,
@@ -318,15 +278,13 @@ export class Vcs {
318
278
  );
319
279
  }
320
280
  /**
321
- * Get installation
322
- *
323
281
  * Get a VCS installation by its unique ID. This endpoint returns the installation&#039;s details including its provider, organization, and configuration.
324
282
  *
325
283
  * @param {string} installationId
326
284
  * @throws {AppwriteException}
327
285
  * @returns {Promise<Models.Installation>}
328
286
  */
329
- async getInstallation(installationId: string): Promise<Models.Installation> {
287
+ getInstallation(installationId: string): Promise<Models.Installation> {
330
288
  if (typeof installationId === 'undefined') {
331
289
  throw new AppwriteException('Missing required parameter: "installationId"');
332
290
  }
@@ -338,10 +296,7 @@ export class Vcs {
338
296
  'content-type': 'application/json',
339
297
  }
340
298
 
341
- payload['project'] = this.client.config.project;
342
-
343
-
344
- return await this.client.call(
299
+ return this.client.call(
345
300
  'get',
346
301
  uri,
347
302
  apiHeaders,
@@ -349,15 +304,13 @@ export class Vcs {
349
304
  );
350
305
  }
351
306
  /**
352
- * Delete installation
353
- *
354
307
  * Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
355
308
  *
356
309
  * @param {string} installationId
357
310
  * @throws {AppwriteException}
358
311
  * @returns {Promise<{}>}
359
312
  */
360
- async deleteInstallation(installationId: string): Promise<{}> {
313
+ deleteInstallation(installationId: string): Promise<{}> {
361
314
  if (typeof installationId === 'undefined') {
362
315
  throw new AppwriteException('Missing required parameter: "installationId"');
363
316
  }
@@ -369,10 +322,7 @@ export class Vcs {
369
322
  'content-type': 'application/json',
370
323
  }
371
324
 
372
- payload['project'] = this.client.config.project;
373
-
374
-
375
- return await this.client.call(
325
+ return this.client.call(
376
326
  'delete',
377
327
  uri,
378
328
  apiHeaders,
@@ -13,6 +13,7 @@ export declare enum OAuthProvider {
13
13
  Dropbox = "dropbox",
14
14
  Etsy = "etsy",
15
15
  Facebook = "facebook",
16
+ Figma = "figma",
16
17
  Github = "github",
17
18
  Gitlab = "gitlab",
18
19
  Google = "google",
package/types/models.d.ts CHANGED
@@ -594,7 +594,7 @@ export declare namespace Models {
594
594
  /**
595
595
  * Collection attributes.
596
596
  */
597
- attributes: string[];
597
+ attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString)[];
598
598
  /**
599
599
  * Collection indexes.
600
600
  */
@@ -611,7 +611,7 @@ export declare namespace Models {
611
611
  /**
612
612
  * List of attributes.
613
613
  */
614
- attributes: string[];
614
+ attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString)[];
615
615
  };
616
616
  /**
617
617
  * AttributeString
@@ -4340,6 +4340,10 @@ export declare namespace Models {
4340
4340
  * Region ID
4341
4341
  */
4342
4342
  $id: string;
4343
+ /**
4344
+ * User ID
4345
+ */
4346
+ userId: string;
4343
4347
  /**
4344
4348
  * Street address
4345
4349
  */
@@ -4456,11 +4460,11 @@ export declare namespace Models {
4456
4460
  /**
4457
4461
  * Additional resources
4458
4462
  */
4459
- usage: AdditionalResource[];
4463
+ usage: UsageBillingPlan;
4460
4464
  /**
4461
4465
  * Addons
4462
4466
  */
4463
- addons: BillingPlanAddon[];
4467
+ addons: BillingPlanAddon;
4464
4468
  /**
4465
4469
  * Custom SMTP
4466
4470
  */
@@ -4514,6 +4518,15 @@ export declare namespace Models {
4514
4518
  * BillingPlanAddon
4515
4519
  */
4516
4520
  type BillingPlanAddon = {
4521
+ /**
4522
+ * Addon seats
4523
+ */
4524
+ seats: BillingPlanAddonDetails;
4525
+ };
4526
+ /**
4527
+ * BillingPlanAddonDetails
4528
+ */
4529
+ type BillingPlanAddonDetails = {
4517
4530
  /**
4518
4531
  * Is the addon supported in the plan?
4519
4532
  */
@@ -4539,6 +4552,39 @@ export declare namespace Models {
4539
4552
  */
4540
4553
  value: number;
4541
4554
  };
4555
+ /**
4556
+ * BillingLimits
4557
+ */
4558
+ type BillingLimits = {
4559
+ /**
4560
+ * Bandwidth limit
4561
+ */
4562
+ bandwidth: number;
4563
+ /**
4564
+ * Storage limit
4565
+ */
4566
+ storage: number;
4567
+ /**
4568
+ * Users limit
4569
+ */
4570
+ users: number;
4571
+ /**
4572
+ * Executions limit
4573
+ */
4574
+ executions: number;
4575
+ /**
4576
+ * GBHours limit
4577
+ */
4578
+ GBHours: number;
4579
+ /**
4580
+ * Image transformations limit
4581
+ */
4582
+ imageTransformations: number;
4583
+ /**
4584
+ * Auth phone limit
4585
+ */
4586
+ authPhone: number;
4587
+ };
4542
4588
  /**
4543
4589
  * Campaign
4544
4590
  */
@@ -4624,6 +4670,10 @@ export declare namespace Models {
4624
4670
  * Status of the coupon. Can be one of `disabled`, `active` or `expired`.
4625
4671
  */
4626
4672
  status: string;
4673
+ /**
4674
+ * If the coupon is only valid for new organizations or not.
4675
+ */
4676
+ onlyNewOrgs: boolean;
4627
4677
  };
4628
4678
  /**
4629
4679
  * Credit
@@ -4726,7 +4776,7 @@ export declare namespace Models {
4726
4776
  /**
4727
4777
  * Usage breakdown per resource
4728
4778
  */
4729
- usage: object;
4779
+ usage: UsageInvoice[];
4730
4780
  /**
4731
4781
  * Invoice Amount
4732
4782
  */
@@ -4899,7 +4949,7 @@ export declare namespace Models {
4899
4949
  /**
4900
4950
  * Billing limits reached
4901
4951
  */
4902
- billingLimits: object;
4952
+ billingLimits: BillingLimits;
4903
4953
  /**
4904
4954
  * Billing plan downgrade
4905
4955
  */
@@ -5285,6 +5335,68 @@ export declare namespace Models {
5285
5335
  */
5286
5336
  authPhoneEstimate: number;
5287
5337
  };
5338
+ /**
5339
+ * UsageInvoice
5340
+ */
5341
+ type UsageInvoice = {
5342
+ /**
5343
+ * Invoice name
5344
+ */
5345
+ name: string;
5346
+ /**
5347
+ * Invoice value
5348
+ */
5349
+ value: number;
5350
+ /**
5351
+ * Invoice amount
5352
+ */
5353
+ amount: number;
5354
+ /**
5355
+ * Invoice rate
5356
+ */
5357
+ rate: number;
5358
+ /**
5359
+ * Invoice description
5360
+ */
5361
+ desc: string;
5362
+ };
5363
+ /**
5364
+ * usageBillingPlan
5365
+ */
5366
+ type UsageBillingPlan = {
5367
+ /**
5368
+ * Bandwidth additional resources
5369
+ */
5370
+ bandwidth: AdditionalResource;
5371
+ /**
5372
+ * Executions additional resources
5373
+ */
5374
+ executions: AdditionalResource;
5375
+ /**
5376
+ * Member additional resources
5377
+ */
5378
+ member: AdditionalResource;
5379
+ /**
5380
+ * Realtime additional resources
5381
+ */
5382
+ realtime: AdditionalResource;
5383
+ /**
5384
+ * Storage additional resources
5385
+ */
5386
+ storage: AdditionalResource;
5387
+ /**
5388
+ * User additional resources
5389
+ */
5390
+ users: AdditionalResource;
5391
+ /**
5392
+ * GBHour additional resources
5393
+ */
5394
+ GBHours: AdditionalResource;
5395
+ /**
5396
+ * Image transformation additional resources
5397
+ */
5398
+ imageTransformations: AdditionalResource;
5399
+ };
5288
5400
  /**
5289
5401
  * Aggregation team list
5290
5402
  */