@appwrite.io/console 2.1.2 → 2.2.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 (137) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +1 -1
  3. package/dist/cjs/sdk.js +2099 -520
  4. package/dist/cjs/sdk.js.map +1 -1
  5. package/dist/esm/sdk.js +2098 -521
  6. package/dist/esm/sdk.js.map +1 -1
  7. package/dist/iife/sdk.js +2003 -444
  8. package/docs/examples/account/create-key.md +15 -0
  9. package/docs/examples/account/delete-key.md +13 -0
  10. package/docs/examples/account/get-key.md +13 -0
  11. package/docs/examples/account/list-keys.md +13 -0
  12. package/docs/examples/account/update-key.md +16 -0
  13. package/docs/examples/avatars/get-screenshot.md +5 -5
  14. package/docs/examples/backups/create-archive.md +2 -2
  15. package/docs/examples/backups/create-policy.md +2 -2
  16. package/docs/examples/backups/create-restoration.md +2 -2
  17. package/docs/examples/console/{get-regions.md → list-regions.md} +1 -3
  18. package/docs/examples/databases/create-index.md +2 -2
  19. package/docs/examples/databases/create-longtext-attribute.md +18 -0
  20. package/docs/examples/databases/create-mediumtext-attribute.md +18 -0
  21. package/docs/examples/databases/create-text-attribute.md +18 -0
  22. package/docs/examples/databases/create-varchar-attribute.md +19 -0
  23. package/docs/examples/databases/update-collection.md +1 -1
  24. package/docs/examples/databases/update-longtext-attribute.md +18 -0
  25. package/docs/examples/databases/update-mediumtext-attribute.md +18 -0
  26. package/docs/examples/databases/update-text-attribute.md +18 -0
  27. package/docs/examples/databases/update-varchar-attribute.md +19 -0
  28. package/docs/examples/databases/update.md +1 -1
  29. package/docs/examples/functions/create.md +2 -2
  30. package/docs/examples/functions/list-templates.md +3 -3
  31. package/docs/examples/functions/update.md +2 -2
  32. package/docs/examples/migrations/create-appwrite-migration.md +2 -2
  33. package/docs/examples/migrations/create-firebase-migration.md +2 -2
  34. package/docs/examples/migrations/create-n-host-migration.md +2 -2
  35. package/docs/examples/migrations/create-supabase-migration.md +2 -2
  36. package/docs/examples/migrations/get-appwrite-report.md +2 -2
  37. package/docs/examples/migrations/get-firebase-report.md +2 -2
  38. package/docs/examples/migrations/get-n-host-report.md +2 -2
  39. package/docs/examples/migrations/get-supabase-report.md +2 -2
  40. package/docs/examples/organizations/create-key.md +16 -0
  41. package/docs/examples/organizations/create.md +2 -2
  42. package/docs/examples/organizations/delete-key.md +14 -0
  43. package/docs/examples/organizations/estimation-create-organization.md +2 -2
  44. package/docs/examples/organizations/estimation-update-plan.md +2 -2
  45. package/docs/examples/organizations/get-key.md +14 -0
  46. package/docs/examples/organizations/list-keys.md +14 -0
  47. package/docs/examples/organizations/list-regions.md +13 -0
  48. package/docs/examples/organizations/update-key.md +17 -0
  49. package/docs/examples/organizations/update-plan.md +2 -2
  50. package/docs/examples/projects/create-jwt.md +2 -2
  51. package/docs/examples/projects/create-key.md +2 -2
  52. package/docs/examples/projects/update-key.md +2 -2
  53. package/docs/examples/sites/list-templates.md +3 -3
  54. package/docs/examples/tablesdb/create-index.md +2 -2
  55. package/docs/examples/tablesdb/create-longtext-column.md +18 -0
  56. package/docs/examples/tablesdb/create-mediumtext-column.md +18 -0
  57. package/docs/examples/tablesdb/create-text-column.md +18 -0
  58. package/docs/examples/tablesdb/create-varchar-column.md +19 -0
  59. package/docs/examples/tablesdb/update-longtext-column.md +18 -0
  60. package/docs/examples/tablesdb/update-mediumtext-column.md +18 -0
  61. package/docs/examples/tablesdb/update-table.md +1 -1
  62. package/docs/examples/tablesdb/update-text-column.md +18 -0
  63. package/docs/examples/tablesdb/update-varchar-column.md +19 -0
  64. package/docs/examples/tablesdb/update.md +1 -1
  65. package/docs/examples/teams/create-membership.md +2 -2
  66. package/docs/examples/teams/update-membership.md +2 -2
  67. package/package.json +3 -2
  68. package/src/channel.ts +138 -0
  69. package/src/client.ts +54 -9
  70. package/src/enums/browser-permission.ts +22 -0
  71. package/src/enums/deployment-status.ts +1 -0
  72. package/src/enums/frameworks.ts +17 -0
  73. package/src/enums/order-by.ts +4 -0
  74. package/src/enums/resources.ts +13 -0
  75. package/src/enums/roles.ts +7 -0
  76. package/src/enums/runtimes.ts +66 -0
  77. package/src/enums/scopes.ts +65 -0
  78. package/src/enums/services.ts +5 -0
  79. package/src/enums/use-cases.ts +11 -0
  80. package/src/index.ts +10 -1
  81. package/src/models.ts +349 -1
  82. package/src/query.ts +42 -0
  83. package/src/services/account.ts +364 -56
  84. package/src/services/assistant.ts +1 -1
  85. package/src/services/avatars.ts +17 -16
  86. package/src/services/backups.ts +37 -36
  87. package/src/services/console.ts +11 -42
  88. package/src/services/databases.ts +1060 -280
  89. package/src/services/domains.ts +44 -44
  90. package/src/services/functions.ts +60 -57
  91. package/src/services/graphql.ts +2 -2
  92. package/src/services/health.ts +22 -20
  93. package/src/services/messaging.ts +56 -56
  94. package/src/services/migrations.ts +79 -78
  95. package/src/services/organizations.ts +466 -70
  96. package/src/services/project.ts +5 -5
  97. package/src/services/projects.ts +86 -85
  98. package/src/services/proxy.ts +8 -8
  99. package/src/services/realtime.ts +35 -12
  100. package/src/services/sites.ts +42 -40
  101. package/src/services/storage.ts +16 -16
  102. package/src/services/tables-db.ts +1050 -268
  103. package/src/services/teams.ts +31 -30
  104. package/src/services/tokens.ts +5 -5
  105. package/src/services/users.ts +49 -49
  106. package/src/services/vcs.ts +10 -10
  107. package/types/channel.d.ts +72 -0
  108. package/types/client.d.ts +11 -3
  109. package/types/enums/browser-permission.d.ts +22 -0
  110. package/types/enums/deployment-status.d.ts +1 -0
  111. package/types/enums/frameworks.d.ts +17 -0
  112. package/types/enums/order-by.d.ts +4 -0
  113. package/types/enums/resources.d.ts +13 -0
  114. package/types/enums/roles.d.ts +7 -0
  115. package/types/enums/runtimes.d.ts +66 -0
  116. package/types/enums/scopes.d.ts +65 -0
  117. package/types/enums/services.d.ts +5 -0
  118. package/types/enums/use-cases.d.ts +11 -0
  119. package/types/index.d.ts +10 -1
  120. package/types/models.d.ts +341 -1
  121. package/types/query.d.ts +30 -0
  122. package/types/services/account.d.ts +111 -0
  123. package/types/services/avatars.d.ts +5 -4
  124. package/types/services/backups.d.ts +13 -12
  125. package/types/services/console.d.ts +1 -13
  126. package/types/services/databases.d.ts +303 -8
  127. package/types/services/functions.d.ts +18 -15
  128. package/types/services/health.d.ts +2 -0
  129. package/types/services/migrations.d.ts +33 -32
  130. package/types/services/organizations.d.ts +161 -17
  131. package/types/services/projects.d.ts +13 -12
  132. package/types/services/realtime.d.ts +17 -8
  133. package/types/services/sites.d.ts +9 -7
  134. package/types/services/tables-db.d.ts +305 -8
  135. package/types/services/teams.d.ts +9 -8
  136. package/src/enums/billing-plan.ts +0 -17
  137. package/types/enums/billing-plan.d.ts +0 -17
@@ -0,0 +1,7 @@
1
+ export enum Roles {
2
+ Developer = 'developer',
3
+ Editor = 'editor',
4
+ Analyst = 'analyst',
5
+ Billing = 'billing',
6
+ Owner = 'owner',
7
+ }
@@ -0,0 +1,66 @@
1
+ export enum Runtimes {
2
+ Node145 = 'node-14.5',
3
+ Node160 = 'node-16.0',
4
+ Node180 = 'node-18.0',
5
+ Node190 = 'node-19.0',
6
+ Node200 = 'node-20.0',
7
+ Node210 = 'node-21.0',
8
+ Node22 = 'node-22',
9
+ Php80 = 'php-8.0',
10
+ Php81 = 'php-8.1',
11
+ Php82 = 'php-8.2',
12
+ Php83 = 'php-8.3',
13
+ Ruby30 = 'ruby-3.0',
14
+ Ruby31 = 'ruby-3.1',
15
+ Ruby32 = 'ruby-3.2',
16
+ Ruby33 = 'ruby-3.3',
17
+ Python38 = 'python-3.8',
18
+ Python39 = 'python-3.9',
19
+ Python310 = 'python-3.10',
20
+ Python311 = 'python-3.11',
21
+ Python312 = 'python-3.12',
22
+ Pythonml311 = 'python-ml-3.11',
23
+ Pythonml312 = 'python-ml-3.12',
24
+ Deno140 = 'deno-1.40',
25
+ Deno146 = 'deno-1.46',
26
+ Deno20 = 'deno-2.0',
27
+ Dart215 = 'dart-2.15',
28
+ Dart216 = 'dart-2.16',
29
+ Dart217 = 'dart-2.17',
30
+ Dart218 = 'dart-2.18',
31
+ Dart219 = 'dart-2.19',
32
+ Dart30 = 'dart-3.0',
33
+ Dart31 = 'dart-3.1',
34
+ Dart33 = 'dart-3.3',
35
+ Dart35 = 'dart-3.5',
36
+ Dart38 = 'dart-3.8',
37
+ Dart39 = 'dart-3.9',
38
+ Dotnet60 = 'dotnet-6.0',
39
+ Dotnet70 = 'dotnet-7.0',
40
+ Dotnet80 = 'dotnet-8.0',
41
+ Java80 = 'java-8.0',
42
+ Java110 = 'java-11.0',
43
+ Java170 = 'java-17.0',
44
+ Java180 = 'java-18.0',
45
+ Java210 = 'java-21.0',
46
+ Java22 = 'java-22',
47
+ Swift55 = 'swift-5.5',
48
+ Swift58 = 'swift-5.8',
49
+ Swift59 = 'swift-5.9',
50
+ Swift510 = 'swift-5.10',
51
+ Kotlin16 = 'kotlin-1.6',
52
+ Kotlin18 = 'kotlin-1.8',
53
+ Kotlin19 = 'kotlin-1.9',
54
+ Kotlin20 = 'kotlin-2.0',
55
+ Cpp17 = 'cpp-17',
56
+ Cpp20 = 'cpp-20',
57
+ Bun10 = 'bun-1.0',
58
+ Bun11 = 'bun-1.1',
59
+ Go123 = 'go-1.23',
60
+ Static1 = 'static-1',
61
+ Flutter324 = 'flutter-3.24',
62
+ Flutter327 = 'flutter-3.27',
63
+ Flutter329 = 'flutter-3.29',
64
+ Flutter332 = 'flutter-3.32',
65
+ Flutter335 = 'flutter-3.35',
66
+ }
@@ -0,0 +1,65 @@
1
+ export enum Scopes {
2
+ SessionsWrite = 'sessions.write',
3
+ UsersRead = 'users.read',
4
+ UsersWrite = 'users.write',
5
+ TeamsRead = 'teams.read',
6
+ TeamsWrite = 'teams.write',
7
+ DatabasesRead = 'databases.read',
8
+ DatabasesWrite = 'databases.write',
9
+ CollectionsRead = 'collections.read',
10
+ CollectionsWrite = 'collections.write',
11
+ TablesRead = 'tables.read',
12
+ TablesWrite = 'tables.write',
13
+ AttributesRead = 'attributes.read',
14
+ AttributesWrite = 'attributes.write',
15
+ ColumnsRead = 'columns.read',
16
+ ColumnsWrite = 'columns.write',
17
+ IndexesRead = 'indexes.read',
18
+ IndexesWrite = 'indexes.write',
19
+ DocumentsRead = 'documents.read',
20
+ DocumentsWrite = 'documents.write',
21
+ RowsRead = 'rows.read',
22
+ RowsWrite = 'rows.write',
23
+ FilesRead = 'files.read',
24
+ FilesWrite = 'files.write',
25
+ BucketsRead = 'buckets.read',
26
+ BucketsWrite = 'buckets.write',
27
+ FunctionsRead = 'functions.read',
28
+ FunctionsWrite = 'functions.write',
29
+ SitesRead = 'sites.read',
30
+ SitesWrite = 'sites.write',
31
+ LogRead = 'log.read',
32
+ LogWrite = 'log.write',
33
+ ExecutionRead = 'execution.read',
34
+ ExecutionWrite = 'execution.write',
35
+ LocaleRead = 'locale.read',
36
+ AvatarsRead = 'avatars.read',
37
+ HealthRead = 'health.read',
38
+ ProvidersRead = 'providers.read',
39
+ ProvidersWrite = 'providers.write',
40
+ MessagesRead = 'messages.read',
41
+ MessagesWrite = 'messages.write',
42
+ TopicsRead = 'topics.read',
43
+ TopicsWrite = 'topics.write',
44
+ SubscribersRead = 'subscribers.read',
45
+ SubscribersWrite = 'subscribers.write',
46
+ TargetsRead = 'targets.read',
47
+ TargetsWrite = 'targets.write',
48
+ RulesRead = 'rules.read',
49
+ RulesWrite = 'rules.write',
50
+ MigrationsRead = 'migrations.read',
51
+ MigrationsWrite = 'migrations.write',
52
+ VcsRead = 'vcs.read',
53
+ VcsWrite = 'vcs.write',
54
+ AssistantRead = 'assistant.read',
55
+ TokensRead = 'tokens.read',
56
+ TokensWrite = 'tokens.write',
57
+ PoliciesWrite = 'policies.write',
58
+ PoliciesRead = 'policies.read',
59
+ ArchivesRead = 'archives.read',
60
+ ArchivesWrite = 'archives.write',
61
+ RestorationsRead = 'restorations.read',
62
+ RestorationsWrite = 'restorations.write',
63
+ DomainsRead = 'domains.read',
64
+ DomainsWrite = 'domains.write',
65
+ }
@@ -0,0 +1,5 @@
1
+ export enum Services {
2
+ Databases = 'databases',
3
+ Functions = 'functions',
4
+ Storage = 'storage',
5
+ }
@@ -0,0 +1,11 @@
1
+ export enum UseCases {
2
+ Portfolio = 'portfolio',
3
+ Starter = 'starter',
4
+ Events = 'events',
5
+ Ecommerce = 'ecommerce',
6
+ Documentation = 'documentation',
7
+ Blog = 'blog',
8
+ Ai = 'ai',
9
+ Forms = 'forms',
10
+ Dashboard = 'dashboard',
11
+ }
package/src/index.ts CHANGED
@@ -36,7 +36,9 @@ export type { QueryTypes, QueryTypesList } from './query';
36
36
  export { Permission } from './permission';
37
37
  export { Role } from './role';
38
38
  export { ID } from './id';
39
+ export { Channel } from './channel';
39
40
  export { Operator, Condition } from './operator';
41
+ export { Scopes } from './enums/scopes';
40
42
  export { AuthenticatorType } from './enums/authenticator-type';
41
43
  export { AuthenticationFactor } from './enums/authentication-factor';
42
44
  export { OAuthProvider } from './enums/o-auth-provider';
@@ -45,15 +47,20 @@ export { CreditCard } from './enums/credit-card';
45
47
  export { Flag } from './enums/flag';
46
48
  export { Theme } from './enums/theme';
47
49
  export { Timezone } from './enums/timezone';
50
+ export { BrowserPermission } from './enums/browser-permission';
48
51
  export { ImageFormat } from './enums/image-format';
52
+ export { Services } from './enums/services';
49
53
  export { Platform } from './enums/platform';
50
54
  export { ConsoleResourceType } from './enums/console-resource-type';
51
55
  export { UsageRange } from './enums/usage-range';
52
56
  export { RelationshipType } from './enums/relationship-type';
53
57
  export { RelationMutate } from './enums/relation-mutate';
54
58
  export { IndexType } from './enums/index-type';
59
+ export { OrderBy } from './enums/order-by';
55
60
  export { FilterType } from './enums/filter-type';
56
61
  export { Runtime } from './enums/runtime';
62
+ export { Runtimes } from './enums/runtimes';
63
+ export { UseCases } from './enums/use-cases';
57
64
  export { TemplateReferenceType } from './enums/template-reference-type';
58
65
  export { VCSReferenceType } from './enums/vcs-reference-type';
59
66
  export { DeploymentDownloadType } from './enums/deployment-download-type';
@@ -61,7 +68,7 @@ export { ExecutionMethod } from './enums/execution-method';
61
68
  export { Name } from './enums/name';
62
69
  export { MessagePriority } from './enums/message-priority';
63
70
  export { SmtpEncryption } from './enums/smtp-encryption';
64
- export { BillingPlan } from './enums/billing-plan';
71
+ export { Resources } from './enums/resources';
65
72
  export { ProjectUsageRange } from './enums/project-usage-range';
66
73
  export { Region } from './enums/region';
67
74
  export { Api } from './enums/api';
@@ -79,8 +86,10 @@ export { ProxyResourceType } from './enums/proxy-resource-type';
79
86
  export { Framework } from './enums/framework';
80
87
  export { BuildRuntime } from './enums/build-runtime';
81
88
  export { Adapter } from './enums/adapter';
89
+ export { Frameworks } from './enums/frameworks';
82
90
  export { Compression } from './enums/compression';
83
91
  export { ImageGravity } from './enums/image-gravity';
92
+ export { Roles } from './enums/roles';
84
93
  export { PasswordHash } from './enums/password-hash';
85
94
  export { MessagingProviderType } from './enums/messaging-provider-type';
86
95
  export { VCSDetectionType } from './enums/vcs-detection-type';
package/src/models.ts CHANGED
@@ -1446,6 +1446,178 @@ export namespace Models {
1446
1446
  default?: any[];
1447
1447
  }
1448
1448
 
1449
+ /**
1450
+ * AttributeVarchar
1451
+ */
1452
+ export type AttributeVarchar = {
1453
+ /**
1454
+ * Attribute Key.
1455
+ */
1456
+ key: string;
1457
+ /**
1458
+ * Attribute type.
1459
+ */
1460
+ type: string;
1461
+ /**
1462
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
1463
+ */
1464
+ status: AttributeStatus;
1465
+ /**
1466
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
1467
+ */
1468
+ error: string;
1469
+ /**
1470
+ * Is attribute required?
1471
+ */
1472
+ required: boolean;
1473
+ /**
1474
+ * Is attribute an array?
1475
+ */
1476
+ array?: boolean;
1477
+ /**
1478
+ * Attribute creation date in ISO 8601 format.
1479
+ */
1480
+ $createdAt: string;
1481
+ /**
1482
+ * Attribute update date in ISO 8601 format.
1483
+ */
1484
+ $updatedAt: string;
1485
+ /**
1486
+ * Attribute size.
1487
+ */
1488
+ size: number;
1489
+ /**
1490
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
1491
+ */
1492
+ default?: string;
1493
+ }
1494
+
1495
+ /**
1496
+ * AttributeText
1497
+ */
1498
+ export type AttributeText = {
1499
+ /**
1500
+ * Attribute Key.
1501
+ */
1502
+ key: string;
1503
+ /**
1504
+ * Attribute type.
1505
+ */
1506
+ type: string;
1507
+ /**
1508
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
1509
+ */
1510
+ status: AttributeStatus;
1511
+ /**
1512
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
1513
+ */
1514
+ error: string;
1515
+ /**
1516
+ * Is attribute required?
1517
+ */
1518
+ required: boolean;
1519
+ /**
1520
+ * Is attribute an array?
1521
+ */
1522
+ array?: boolean;
1523
+ /**
1524
+ * Attribute creation date in ISO 8601 format.
1525
+ */
1526
+ $createdAt: string;
1527
+ /**
1528
+ * Attribute update date in ISO 8601 format.
1529
+ */
1530
+ $updatedAt: string;
1531
+ /**
1532
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
1533
+ */
1534
+ default?: string;
1535
+ }
1536
+
1537
+ /**
1538
+ * AttributeMediumtext
1539
+ */
1540
+ export type AttributeMediumtext = {
1541
+ /**
1542
+ * Attribute Key.
1543
+ */
1544
+ key: string;
1545
+ /**
1546
+ * Attribute type.
1547
+ */
1548
+ type: string;
1549
+ /**
1550
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
1551
+ */
1552
+ status: AttributeStatus;
1553
+ /**
1554
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
1555
+ */
1556
+ error: string;
1557
+ /**
1558
+ * Is attribute required?
1559
+ */
1560
+ required: boolean;
1561
+ /**
1562
+ * Is attribute an array?
1563
+ */
1564
+ array?: boolean;
1565
+ /**
1566
+ * Attribute creation date in ISO 8601 format.
1567
+ */
1568
+ $createdAt: string;
1569
+ /**
1570
+ * Attribute update date in ISO 8601 format.
1571
+ */
1572
+ $updatedAt: string;
1573
+ /**
1574
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
1575
+ */
1576
+ default?: string;
1577
+ }
1578
+
1579
+ /**
1580
+ * AttributeLongtext
1581
+ */
1582
+ export type AttributeLongtext = {
1583
+ /**
1584
+ * Attribute Key.
1585
+ */
1586
+ key: string;
1587
+ /**
1588
+ * Attribute type.
1589
+ */
1590
+ type: string;
1591
+ /**
1592
+ * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
1593
+ */
1594
+ status: AttributeStatus;
1595
+ /**
1596
+ * Error message. Displays error generated on failure of creating or deleting an attribute.
1597
+ */
1598
+ error: string;
1599
+ /**
1600
+ * Is attribute required?
1601
+ */
1602
+ required: boolean;
1603
+ /**
1604
+ * Is attribute an array?
1605
+ */
1606
+ array?: boolean;
1607
+ /**
1608
+ * Attribute creation date in ISO 8601 format.
1609
+ */
1610
+ $createdAt: string;
1611
+ /**
1612
+ * Attribute update date in ISO 8601 format.
1613
+ */
1614
+ $updatedAt: string;
1615
+ /**
1616
+ * Default value for attribute when not provided. Cannot be set when attribute is required.
1617
+ */
1618
+ default?: string;
1619
+ }
1620
+
1449
1621
  /**
1450
1622
  * Table
1451
1623
  */
@@ -2120,6 +2292,178 @@ export namespace Models {
2120
2292
  default?: any[];
2121
2293
  }
2122
2294
 
2295
+ /**
2296
+ * ColumnVarchar
2297
+ */
2298
+ export type ColumnVarchar = {
2299
+ /**
2300
+ * Column Key.
2301
+ */
2302
+ key: string;
2303
+ /**
2304
+ * Column type.
2305
+ */
2306
+ type: string;
2307
+ /**
2308
+ * Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
2309
+ */
2310
+ status: ColumnStatus;
2311
+ /**
2312
+ * Error message. Displays error generated on failure of creating or deleting an column.
2313
+ */
2314
+ error: string;
2315
+ /**
2316
+ * Is column required?
2317
+ */
2318
+ required: boolean;
2319
+ /**
2320
+ * Is column an array?
2321
+ */
2322
+ array?: boolean;
2323
+ /**
2324
+ * Column creation date in ISO 8601 format.
2325
+ */
2326
+ $createdAt: string;
2327
+ /**
2328
+ * Column update date in ISO 8601 format.
2329
+ */
2330
+ $updatedAt: string;
2331
+ /**
2332
+ * Column size.
2333
+ */
2334
+ size: number;
2335
+ /**
2336
+ * Default value for column when not provided. Cannot be set when column is required.
2337
+ */
2338
+ default?: string;
2339
+ }
2340
+
2341
+ /**
2342
+ * ColumnText
2343
+ */
2344
+ export type ColumnText = {
2345
+ /**
2346
+ * Column Key.
2347
+ */
2348
+ key: string;
2349
+ /**
2350
+ * Column type.
2351
+ */
2352
+ type: string;
2353
+ /**
2354
+ * Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
2355
+ */
2356
+ status: ColumnStatus;
2357
+ /**
2358
+ * Error message. Displays error generated on failure of creating or deleting an column.
2359
+ */
2360
+ error: string;
2361
+ /**
2362
+ * Is column required?
2363
+ */
2364
+ required: boolean;
2365
+ /**
2366
+ * Is column an array?
2367
+ */
2368
+ array?: boolean;
2369
+ /**
2370
+ * Column creation date in ISO 8601 format.
2371
+ */
2372
+ $createdAt: string;
2373
+ /**
2374
+ * Column update date in ISO 8601 format.
2375
+ */
2376
+ $updatedAt: string;
2377
+ /**
2378
+ * Default value for column when not provided. Cannot be set when column is required.
2379
+ */
2380
+ default?: string;
2381
+ }
2382
+
2383
+ /**
2384
+ * ColumnMediumtext
2385
+ */
2386
+ export type ColumnMediumtext = {
2387
+ /**
2388
+ * Column Key.
2389
+ */
2390
+ key: string;
2391
+ /**
2392
+ * Column type.
2393
+ */
2394
+ type: string;
2395
+ /**
2396
+ * Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
2397
+ */
2398
+ status: ColumnStatus;
2399
+ /**
2400
+ * Error message. Displays error generated on failure of creating or deleting an column.
2401
+ */
2402
+ error: string;
2403
+ /**
2404
+ * Is column required?
2405
+ */
2406
+ required: boolean;
2407
+ /**
2408
+ * Is column an array?
2409
+ */
2410
+ array?: boolean;
2411
+ /**
2412
+ * Column creation date in ISO 8601 format.
2413
+ */
2414
+ $createdAt: string;
2415
+ /**
2416
+ * Column update date in ISO 8601 format.
2417
+ */
2418
+ $updatedAt: string;
2419
+ /**
2420
+ * Default value for column when not provided. Cannot be set when column is required.
2421
+ */
2422
+ default?: string;
2423
+ }
2424
+
2425
+ /**
2426
+ * ColumnLongtext
2427
+ */
2428
+ export type ColumnLongtext = {
2429
+ /**
2430
+ * Column Key.
2431
+ */
2432
+ key: string;
2433
+ /**
2434
+ * Column type.
2435
+ */
2436
+ type: string;
2437
+ /**
2438
+ * Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
2439
+ */
2440
+ status: ColumnStatus;
2441
+ /**
2442
+ * Error message. Displays error generated on failure of creating or deleting an column.
2443
+ */
2444
+ error: string;
2445
+ /**
2446
+ * Is column required?
2447
+ */
2448
+ required: boolean;
2449
+ /**
2450
+ * Is column an array?
2451
+ */
2452
+ array?: boolean;
2453
+ /**
2454
+ * Column creation date in ISO 8601 format.
2455
+ */
2456
+ $createdAt: string;
2457
+ /**
2458
+ * Column update date in ISO 8601 format.
2459
+ */
2460
+ $updatedAt: string;
2461
+ /**
2462
+ * Default value for column when not provided. Cannot be set when column is required.
2463
+ */
2464
+ default?: string;
2465
+ }
2466
+
2123
2467
  /**
2124
2468
  * Index
2125
2469
  */
@@ -3944,7 +4288,7 @@ export namespace Models {
3944
4288
  */
3945
4289
  screenshotDark: string;
3946
4290
  /**
3947
- * The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed".
4291
+ * The deployment status. Possible values are "waiting", "processing", "building", "ready", "canceled" and "failed".
3948
4292
  */
3949
4293
  status: DeploymentStatus;
3950
4294
  /**
@@ -6669,6 +7013,10 @@ export namespace Models {
6669
7013
  * Image Transformations
6670
7014
  */
6671
7015
  imageTransformations: number;
7016
+ /**
7017
+ * Screenshots generated
7018
+ */
7019
+ screenshotsGenerated: number;
6672
7020
  /**
6673
7021
  * Members
6674
7022
  */
package/src/query.ts CHANGED
@@ -71,6 +71,16 @@ export class Query {
71
71
  static notEqual = (attribute: string, value: QueryTypes): string =>
72
72
  new Query("notEqual", attribute, value).toString();
73
73
 
74
+ /**
75
+ * Filter resources where attribute matches a regular expression pattern.
76
+ *
77
+ * @param {string} attribute The attribute to filter on.
78
+ * @param {string} pattern The regular expression pattern to match.
79
+ * @returns {string}
80
+ */
81
+ static regex = (attribute: string, pattern: string): string =>
82
+ new Query("regex", attribute, pattern).toString();
83
+
74
84
  /**
75
85
  * Filter resources where attribute is less than value.
76
86
  *
@@ -129,6 +139,24 @@ export class Query {
129
139
  static isNotNull = (attribute: string): string =>
130
140
  new Query("isNotNull", attribute).toString();
131
141
 
142
+ /**
143
+ * Filter resources where the specified attributes exist.
144
+ *
145
+ * @param {string[]} attributes The list of attributes that must exist.
146
+ * @returns {string}
147
+ */
148
+ static exists = (attributes: string[]): string =>
149
+ new Query("exists", undefined, attributes).toString();
150
+
151
+ /**
152
+ * Filter resources where the specified attributes do not exist.
153
+ *
154
+ * @param {string[]} attributes The list of attributes that must not exist.
155
+ * @returns {string}
156
+ */
157
+ static notExists = (attributes: string[]): string =>
158
+ new Query("notExists", undefined, attributes).toString();
159
+
132
160
  /**
133
161
  * Filter resources where attribute is between start and end (inclusive).
134
162
  *
@@ -378,6 +406,20 @@ export class Query {
378
406
  static and = (queries: string[]) =>
379
407
  new Query("and", undefined, queries.map((query) => JSONbig.parse(query))).toString();
380
408
 
409
+ /**
410
+ * Filter array elements where at least one element matches all the specified queries.
411
+ *
412
+ * @param {string} attribute The attribute containing the array to filter on.
413
+ * @param {string[]} queries The list of query strings to match against array elements.
414
+ * @returns {string}
415
+ */
416
+ static elemMatch = (attribute: string, queries: string[]): string =>
417
+ new Query(
418
+ "elemMatch",
419
+ attribute,
420
+ queries.map((query) => JSONbig.parse(query))
421
+ ).toString();
422
+
381
423
  /**
382
424
  * Filter resources where attribute is at a specific distance from the given coordinates.
383
425
  *