@appwrite.io/console 2.1.1 → 2.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +1 -1
  3. package/dist/cjs/sdk.js +99 -7
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +100 -8
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +99 -7
  8. package/docs/examples/domains/list-suggestions.md +18 -0
  9. package/docs/examples/health/get-queue-audits.md +13 -0
  10. package/docs/examples/organizations/create.md +2 -2
  11. package/docs/examples/organizations/estimation-create-organization.md +2 -2
  12. package/docs/examples/organizations/estimation-update-plan.md +2 -2
  13. package/docs/examples/organizations/update-plan.md +2 -2
  14. package/package.json +1 -1
  15. package/src/client.ts +1 -1
  16. package/src/enums/billing-plan.ts +17 -0
  17. package/src/enums/filter-type.ts +4 -0
  18. package/src/enums/name.ts +1 -0
  19. package/src/enums/o-auth-provider.ts +0 -2
  20. package/src/index.ts +2 -0
  21. package/src/models.ts +437 -375
  22. package/src/services/account.ts +20 -20
  23. package/src/services/avatars.ts +117 -117
  24. package/src/services/backups.ts +18 -18
  25. package/src/services/console.ts +24 -24
  26. package/src/services/databases.ts +89 -89
  27. package/src/services/domains.ts +295 -204
  28. package/src/services/functions.ts +30 -30
  29. package/src/services/health.ts +201 -152
  30. package/src/services/messaging.ts +54 -54
  31. package/src/services/migrations.ts +36 -36
  32. package/src/services/organizations.ts +67 -66
  33. package/src/services/projects.ts +81 -81
  34. package/src/services/sites.ts +30 -30
  35. package/src/services/storage.ts +45 -45
  36. package/src/services/tables-db.ts +89 -89
  37. package/src/services/users.ts +39 -39
  38. package/types/enums/billing-plan.d.ts +17 -0
  39. package/types/enums/filter-type.d.ts +4 -0
  40. package/types/enums/name.d.ts +1 -0
  41. package/types/enums/o-auth-provider.d.ts +0 -2
  42. package/types/index.d.ts +2 -0
  43. package/types/models.d.ts +434 -375
  44. package/types/services/account.d.ts +11 -11
  45. package/types/services/avatars.d.ts +82 -82
  46. package/types/services/backups.d.ts +8 -8
  47. package/types/services/console.d.ts +14 -14
  48. package/types/services/databases.d.ts +50 -50
  49. package/types/services/domains.d.ts +139 -104
  50. package/types/services/functions.d.ts +15 -15
  51. package/types/services/health.d.ts +95 -78
  52. package/types/services/messaging.d.ts +24 -24
  53. package/types/services/migrations.d.ts +16 -16
  54. package/types/services/organizations.d.ts +37 -36
  55. package/types/services/projects.d.ts +36 -36
  56. package/types/services/sites.d.ts +15 -15
  57. package/types/services/storage.d.ts +30 -30
  58. package/types/services/tables-db.d.ts +50 -50
  59. package/types/services/users.d.ts +24 -24
@@ -283,7 +283,7 @@ export class Backups {
283
283
  *
284
284
  * @param {string} params.policyId - Policy 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.
285
285
  * @param {string[]} params.services - Array of services to backup
286
- * @param {number | bigint} params.retention - Days to keep backups before deletion
286
+ * @param {number} params.retention - Days to keep backups before deletion
287
287
  * @param {string} params.schedule - Schedule CRON syntax.
288
288
  * @param {string} params.name - Policy name. Max length: 128 chars.
289
289
  * @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
@@ -291,13 +291,13 @@ export class Backups {
291
291
  * @throws {AppwriteException}
292
292
  * @returns {Promise<Models.BackupPolicy>}
293
293
  */
294
- createPolicy(params: { policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
294
+ createPolicy(params: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
295
295
  /**
296
296
  * Create a new backup policy.
297
297
  *
298
298
  * @param {string} policyId - Policy 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.
299
299
  * @param {string[]} services - Array of services to backup
300
- * @param {number | bigint} retention - Days to keep backups before deletion
300
+ * @param {number} retention - Days to keep backups before deletion
301
301
  * @param {string} schedule - Schedule CRON syntax.
302
302
  * @param {string} name - Policy name. Max length: 128 chars.
303
303
  * @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
@@ -306,20 +306,20 @@ export class Backups {
306
306
  * @returns {Promise<Models.BackupPolicy>}
307
307
  * @deprecated Use the object parameter style method for a better developer experience.
308
308
  */
309
- createPolicy(policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
309
+ createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
310
310
  createPolicy(
311
- paramsOrFirst: { policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean } | string,
312
- ...rest: [(string[])?, (number | bigint)?, (string)?, (string)?, (string)?, (boolean)?]
311
+ paramsOrFirst: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean } | string,
312
+ ...rest: [(string[])?, (number)?, (string)?, (string)?, (string)?, (boolean)?]
313
313
  ): Promise<Models.BackupPolicy> {
314
- let params: { policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
314
+ let params: { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
315
315
 
316
316
  if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
317
- params = (paramsOrFirst || {}) as { policyId: string, services: string[], retention: number | bigint, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
317
+ params = (paramsOrFirst || {}) as { policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean };
318
318
  } else {
319
319
  params = {
320
320
  policyId: paramsOrFirst as string,
321
321
  services: rest[0] as string[],
322
- retention: rest[1] as number | bigint,
322
+ retention: rest[1] as number,
323
323
  schedule: rest[2] as string,
324
324
  name: rest[3] as string,
325
325
  resourceId: rest[4] as string,
@@ -441,39 +441,39 @@ export class Backups {
441
441
  *
442
442
  * @param {string} params.policyId - Policy ID. Choose a custom ID`. 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.
443
443
  * @param {string} params.name - Policy name. Max length: 128 chars.
444
- * @param {number | bigint} params.retention - Days to keep backups before deletion
444
+ * @param {number} params.retention - Days to keep backups before deletion
445
445
  * @param {string} params.schedule - Cron expression
446
446
  * @param {boolean} params.enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
447
447
  * @throws {AppwriteException}
448
448
  * @returns {Promise<Models.BackupPolicy>}
449
449
  */
450
- updatePolicy(params: { policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
450
+ updatePolicy(params: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean }): Promise<Models.BackupPolicy>;
451
451
  /**
452
452
  * Update an existing policy using it's ID.
453
453
  *
454
454
  * @param {string} policyId - Policy ID. Choose a custom ID`. 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.
455
455
  * @param {string} name - Policy name. Max length: 128 chars.
456
- * @param {number | bigint} retention - Days to keep backups before deletion
456
+ * @param {number} retention - Days to keep backups before deletion
457
457
  * @param {string} schedule - Cron expression
458
458
  * @param {boolean} enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
459
459
  * @throws {AppwriteException}
460
460
  * @returns {Promise<Models.BackupPolicy>}
461
461
  * @deprecated Use the object parameter style method for a better developer experience.
462
462
  */
463
- updatePolicy(policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
463
+ updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
464
464
  updatePolicy(
465
- paramsOrFirst: { policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean } | string,
466
- ...rest: [(string)?, (number | bigint)?, (string)?, (boolean)?]
465
+ paramsOrFirst: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean } | string,
466
+ ...rest: [(string)?, (number)?, (string)?, (boolean)?]
467
467
  ): Promise<Models.BackupPolicy> {
468
- let params: { policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean };
468
+ let params: { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean };
469
469
 
470
470
  if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
471
- params = (paramsOrFirst || {}) as { policyId: string, name?: string, retention?: number | bigint, schedule?: string, enabled?: boolean };
471
+ params = (paramsOrFirst || {}) as { policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean };
472
472
  } else {
473
473
  params = {
474
474
  policyId: paramsOrFirst as string,
475
475
  name: rest[0] as string,
476
- retention: rest[1] as number | bigint,
476
+ retention: rest[1] as number,
477
477
  schedule: rest[2] as string,
478
478
  enabled: rest[3] as boolean
479
479
  };
@@ -525,40 +525,40 @@ export class Console {
525
525
  * @param {string} params.databaseId - Database ID.
526
526
  * @param {string} params.tableId - Table ID.
527
527
  * @param {string} params.context - Optional user provided context to refine suggestions.
528
- * @param {number | bigint} params.min - Minimum number of suggestions to generate.
529
- * @param {number | bigint} params.max - Maximum number of suggestions to generate.
528
+ * @param {number} params.min - Minimum number of suggestions to generate.
529
+ * @param {number} params.max - Maximum number of suggestions to generate.
530
530
  * @throws {AppwriteException}
531
531
  * @returns {Promise<Models.ColumnList>}
532
532
  */
533
- suggestColumns(params: { databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint }): Promise<Models.ColumnList>;
533
+ suggestColumns(params: { databaseId: string, tableId: string, context?: string, min?: number, max?: number }): Promise<Models.ColumnList>;
534
534
  /**
535
535
  * Suggests column names and their size limits based on the provided table name. The API will also analyze other tables in the same database to provide context-aware suggestions, ensuring consistency across schema design. Users may optionally provide custom context to further refine the suggestions.
536
536
  *
537
537
  * @param {string} databaseId - Database ID.
538
538
  * @param {string} tableId - Table ID.
539
539
  * @param {string} context - Optional user provided context to refine suggestions.
540
- * @param {number | bigint} min - Minimum number of suggestions to generate.
541
- * @param {number | bigint} max - Maximum number of suggestions to generate.
540
+ * @param {number} min - Minimum number of suggestions to generate.
541
+ * @param {number} max - Maximum number of suggestions to generate.
542
542
  * @throws {AppwriteException}
543
543
  * @returns {Promise<Models.ColumnList>}
544
544
  * @deprecated Use the object parameter style method for a better developer experience.
545
545
  */
546
- suggestColumns(databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint): Promise<Models.ColumnList>;
546
+ suggestColumns(databaseId: string, tableId: string, context?: string, min?: number, max?: number): Promise<Models.ColumnList>;
547
547
  suggestColumns(
548
- paramsOrFirst: { databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint } | string,
549
- ...rest: [(string)?, (string)?, (number | bigint)?, (number | bigint)?]
548
+ paramsOrFirst: { databaseId: string, tableId: string, context?: string, min?: number, max?: number } | string,
549
+ ...rest: [(string)?, (string)?, (number)?, (number)?]
550
550
  ): Promise<Models.ColumnList> {
551
- let params: { databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint };
551
+ let params: { databaseId: string, tableId: string, context?: string, min?: number, max?: number };
552
552
 
553
553
  if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
554
- params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, context?: string, min?: number | bigint, max?: number | bigint };
554
+ params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, context?: string, min?: number, max?: number };
555
555
  } else {
556
556
  params = {
557
557
  databaseId: paramsOrFirst as string,
558
558
  tableId: rest[0] as string,
559
559
  context: rest[1] as string,
560
- min: rest[2] as number | bigint,
561
- max: rest[3] as number | bigint
560
+ min: rest[2] as number,
561
+ max: rest[3] as number
562
562
  };
563
563
  }
564
564
 
@@ -610,38 +610,38 @@ export class Console {
610
610
  *
611
611
  * @param {string} params.databaseId - Database ID.
612
612
  * @param {string} params.tableId - Table ID.
613
- * @param {number | bigint} params.min - Minimum number of suggestions to generate.
614
- * @param {number | bigint} params.max - Maximum number of suggestions to generate.
613
+ * @param {number} params.min - Minimum number of suggestions to generate.
614
+ * @param {number} params.max - Maximum number of suggestions to generate.
615
615
  * @throws {AppwriteException}
616
616
  * @returns {Promise<Models.ColumnIndexList>}
617
617
  */
618
- suggestIndexes(params: { databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint }): Promise<Models.ColumnIndexList>;
618
+ suggestIndexes(params: { databaseId: string, tableId: string, min?: number, max?: number }): Promise<Models.ColumnIndexList>;
619
619
  /**
620
620
  * Suggests database indexes for table columns based on the provided table structure and existing columns. The API will also analyze the table's column types, names, and patterns to recommend optimal indexes that improve query performance for common database operations like filtering, sorting, and searching.
621
621
  *
622
622
  * @param {string} databaseId - Database ID.
623
623
  * @param {string} tableId - Table ID.
624
- * @param {number | bigint} min - Minimum number of suggestions to generate.
625
- * @param {number | bigint} max - Maximum number of suggestions to generate.
624
+ * @param {number} min - Minimum number of suggestions to generate.
625
+ * @param {number} max - Maximum number of suggestions to generate.
626
626
  * @throws {AppwriteException}
627
627
  * @returns {Promise<Models.ColumnIndexList>}
628
628
  * @deprecated Use the object parameter style method for a better developer experience.
629
629
  */
630
- suggestIndexes(databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint): Promise<Models.ColumnIndexList>;
630
+ suggestIndexes(databaseId: string, tableId: string, min?: number, max?: number): Promise<Models.ColumnIndexList>;
631
631
  suggestIndexes(
632
- paramsOrFirst: { databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint } | string,
633
- ...rest: [(string)?, (number | bigint)?, (number | bigint)?]
632
+ paramsOrFirst: { databaseId: string, tableId: string, min?: number, max?: number } | string,
633
+ ...rest: [(string)?, (number)?, (number)?]
634
634
  ): Promise<Models.ColumnIndexList> {
635
- let params: { databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint };
635
+ let params: { databaseId: string, tableId: string, min?: number, max?: number };
636
636
 
637
637
  if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
638
- params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, min?: number | bigint, max?: number | bigint };
638
+ params = (paramsOrFirst || {}) as { databaseId: string, tableId: string, min?: number, max?: number };
639
639
  } else {
640
640
  params = {
641
641
  databaseId: paramsOrFirst as string,
642
642
  tableId: rest[0] as string,
643
- min: rest[1] as number | bigint,
644
- max: rest[2] as number | bigint
643
+ min: rest[1] as number,
644
+ max: rest[2] as number
645
645
  };
646
646
  }
647
647