appwrite 29.0.0 → 30.0.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 (76) hide show
  1. checksums.yaml +4 -4
  2. data/lib/appwrite/client.rb +3 -3
  3. data/lib/appwrite/models/attribute_bigint.rb +6 -1
  4. data/lib/appwrite/models/attribute_boolean.rb +6 -1
  5. data/lib/appwrite/models/attribute_datetime.rb +6 -1
  6. data/lib/appwrite/models/attribute_email.rb +6 -1
  7. data/lib/appwrite/models/attribute_enum.rb +6 -1
  8. data/lib/appwrite/models/attribute_float.rb +6 -1
  9. data/lib/appwrite/models/attribute_integer.rb +6 -1
  10. data/lib/appwrite/models/attribute_ip.rb +6 -1
  11. data/lib/appwrite/models/attribute_line.rb +6 -1
  12. data/lib/appwrite/models/attribute_longtext.rb +6 -1
  13. data/lib/appwrite/models/attribute_mediumtext.rb +6 -1
  14. data/lib/appwrite/models/attribute_object.rb +6 -1
  15. data/lib/appwrite/models/attribute_point.rb +6 -1
  16. data/lib/appwrite/models/attribute_polygon.rb +6 -1
  17. data/lib/appwrite/models/attribute_relationship.rb +6 -1
  18. data/lib/appwrite/models/attribute_string.rb +6 -1
  19. data/lib/appwrite/models/attribute_text.rb +6 -1
  20. data/lib/appwrite/models/attribute_url.rb +6 -1
  21. data/lib/appwrite/models/attribute_varchar.rb +6 -1
  22. data/lib/appwrite/models/attribute_vector.rb +6 -1
  23. data/lib/appwrite/models/billing_plan.rb +6 -1
  24. data/lib/appwrite/models/bucket.rb +11 -1
  25. data/lib/appwrite/models/collection.rb +6 -1
  26. data/lib/appwrite/models/column_bigint.rb +6 -1
  27. data/lib/appwrite/models/column_boolean.rb +6 -1
  28. data/lib/appwrite/models/column_datetime.rb +6 -1
  29. data/lib/appwrite/models/column_email.rb +6 -1
  30. data/lib/appwrite/models/column_enum.rb +6 -1
  31. data/lib/appwrite/models/column_float.rb +6 -1
  32. data/lib/appwrite/models/column_index.rb +6 -1
  33. data/lib/appwrite/models/column_integer.rb +6 -1
  34. data/lib/appwrite/models/column_ip.rb +6 -1
  35. data/lib/appwrite/models/column_line.rb +6 -1
  36. data/lib/appwrite/models/column_longtext.rb +6 -1
  37. data/lib/appwrite/models/column_mediumtext.rb +6 -1
  38. data/lib/appwrite/models/column_point.rb +6 -1
  39. data/lib/appwrite/models/column_polygon.rb +6 -1
  40. data/lib/appwrite/models/column_relationship.rb +6 -1
  41. data/lib/appwrite/models/column_string.rb +6 -1
  42. data/lib/appwrite/models/column_text.rb +6 -1
  43. data/lib/appwrite/models/column_url.rb +6 -1
  44. data/lib/appwrite/models/column_varchar.rb +6 -1
  45. data/lib/appwrite/models/database.rb +6 -1
  46. data/lib/appwrite/models/ephemeral_key.rb +6 -1
  47. data/lib/appwrite/models/function.rb +6 -1
  48. data/lib/appwrite/models/index.rb +6 -1
  49. data/lib/appwrite/models/key.rb +6 -1
  50. data/lib/appwrite/models/policy_password_dictionary.rb +9 -4
  51. data/lib/appwrite/models/policy_password_personal_data.rb +9 -4
  52. data/lib/appwrite/models/site.rb +6 -1
  53. data/lib/appwrite/models/table.rb +6 -1
  54. data/lib/appwrite/models/topic.rb +6 -1
  55. data/lib/appwrite/models/variable.rb +6 -1
  56. data/lib/appwrite/models/vectorsdb_collection.rb +6 -1
  57. data/lib/appwrite/models/webhook.rb +6 -1
  58. data/lib/appwrite/services/account.rb +48 -0
  59. data/lib/appwrite/services/activities.rb +4 -1
  60. data/lib/appwrite/services/backups.rb +12 -3
  61. data/lib/appwrite/services/databases.rb +233 -42
  62. data/lib/appwrite/services/documents_db.rb +74 -3
  63. data/lib/appwrite/services/domains.rb +8 -2
  64. data/lib/appwrite/services/functions.rb +15 -3
  65. data/lib/appwrite/services/messaging.rb +16 -4
  66. data/lib/appwrite/services/mongo.rb +12 -3
  67. data/lib/appwrite/services/mysql.rb +12 -3
  68. data/lib/appwrite/services/organization.rb +4 -1
  69. data/lib/appwrite/services/postgresql.rb +12 -3
  70. data/lib/appwrite/services/project.rb +38 -5
  71. data/lib/appwrite/services/sites.rb +16 -4
  72. data/lib/appwrite/services/storage.rb +15 -3
  73. data/lib/appwrite/services/tables_db.rb +227 -40
  74. data/lib/appwrite/services/vectors_db.rb +18 -3
  75. data/lib/appwrite/services/webhooks.rb +8 -2
  76. metadata +3 -3
@@ -44,6 +44,7 @@ module Appwrite
44
44
  # @param [String] database_id Unique 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.
45
45
  # @param [String] name Database name. Max length: 128 chars.
46
46
  # @param [] enabled Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
47
+ # @param [String] description Optional description for the database.
47
48
  # @param [String] specification Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
48
49
  # @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.
49
50
  # @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
@@ -53,6 +54,7 @@ module Appwrite
53
54
  database_id:,
54
55
  name:,
55
56
  enabled: nil,
57
+ description: nil,
56
58
  specification: nil,
57
59
  replicas: nil,
58
60
  sync_mode: nil
@@ -71,6 +73,7 @@ module Appwrite
71
73
  databaseId: database_id,
72
74
  name: name,
73
75
  enabled: enabled,
76
+ description: description,
74
77
  specification: specification,
75
78
  replicas: replicas,
76
79
  syncMode: sync_mode,
@@ -350,6 +353,7 @@ module Appwrite
350
353
  # @param [String] database_id Database ID.
351
354
  # @param [String] name Database name. Max length: 128 chars.
352
355
  # @param [] enabled Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
356
+ # @param [String] description Optional description for the database.
353
357
  # @param [String] specification Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
354
358
  # @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
355
359
  # @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
@@ -359,6 +363,7 @@ module Appwrite
359
363
  database_id:,
360
364
  name:,
361
365
  enabled: nil,
366
+ description: nil,
362
367
  specification: nil,
363
368
  replicas: nil,
364
369
  sync_mode: nil
@@ -377,6 +382,7 @@ module Appwrite
377
382
  api_params = {
378
383
  name: name,
379
384
  enabled: enabled,
385
+ description: description,
380
386
  specification: specification,
381
387
  replicas: replicas,
382
388
  syncMode: sync_mode,
@@ -483,6 +489,7 @@ module Appwrite
483
489
  # @param [Array] permissions An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
484
490
  # @param [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
485
491
  # @param [] enabled Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
492
+ # @param [String] description Optional description for the collection.
486
493
  #
487
494
  # @return [VectorsdbCollection]
488
495
  def create_collection(
@@ -492,7 +499,8 @@ module Appwrite
492
499
  dimension:,
493
500
  permissions: nil,
494
501
  document_security: nil,
495
- enabled: nil
502
+ enabled: nil,
503
+ description: nil
496
504
  )
497
505
  if database_id.nil? || database_id == ''
498
506
  raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
@@ -520,6 +528,7 @@ module Appwrite
520
528
  permissions: permissions,
521
529
  documentSecurity: document_security,
522
530
  enabled: enabled,
531
+ description: description,
523
532
  }
524
533
 
525
534
  api_headers = {
@@ -585,6 +594,7 @@ module Appwrite
585
594
  # @param [Array] permissions An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
586
595
  # @param [] document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
587
596
  # @param [] enabled Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
597
+ # @param [String] description Optional description for the collection.
588
598
  #
589
599
  # @return [VectorsdbCollection]
590
600
  def update_collection(
@@ -594,7 +604,8 @@ module Appwrite
594
604
  dimension: nil,
595
605
  permissions: nil,
596
606
  document_security: nil,
597
- enabled: nil
607
+ enabled: nil,
608
+ description: nil
598
609
  )
599
610
  if database_id.nil? || database_id == ''
600
611
  raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
@@ -618,6 +629,7 @@ module Appwrite
618
629
  permissions: permissions,
619
630
  documentSecurity: document_security,
620
631
  enabled: enabled,
632
+ description: description,
621
633
  }
622
634
 
623
635
  api_headers = {
@@ -1324,6 +1336,7 @@ module Appwrite
1324
1336
  # @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
1325
1337
  # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
1326
1338
  # @param [Array] lengths Length of index. Maximum of 100
1339
+ # @param [String] description Optional description for the index.
1327
1340
  #
1328
1341
  # @return [Index]
1329
1342
  def create_index(
@@ -1333,7 +1346,8 @@ module Appwrite
1333
1346
  type:,
1334
1347
  attributes:,
1335
1348
  orders: nil,
1336
- lengths: nil
1349
+ lengths: nil,
1350
+ description: nil
1337
1351
  )
1338
1352
  if database_id.nil? || database_id == ''
1339
1353
  raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
@@ -1365,6 +1379,7 @@ module Appwrite
1365
1379
  attributes: attributes,
1366
1380
  orders: orders,
1367
1381
  lengths: lengths,
1382
+ description: description,
1368
1383
  }
1369
1384
 
1370
1385
  api_headers = {
@@ -50,6 +50,7 @@ module Appwrite
50
50
  # @param [String] auth_username Webhook HTTP user. Max length: 255 chars.
51
51
  # @param [String] auth_password Webhook HTTP password. Max length: 2048 chars.
52
52
  # @param [String] secret Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
53
+ # @param [String] description Optional description for the webhook.
53
54
  #
54
55
  # @return [Webhook]
55
56
  def create(
@@ -61,7 +62,8 @@ module Appwrite
61
62
  tls: nil,
62
63
  auth_username: nil,
63
64
  auth_password: nil,
64
- secret: nil
65
+ secret: nil,
66
+ description: nil
65
67
  )
66
68
  if webhook_id.nil?
67
69
  raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
@@ -91,6 +93,7 @@ module Appwrite
91
93
  authUsername: auth_username,
92
94
  authPassword: auth_password,
93
95
  secret: secret,
96
+ description: description,
94
97
  }
95
98
 
96
99
  api_headers = {
@@ -151,6 +154,7 @@ module Appwrite
151
154
  # @param [] tls Certificate verification, false for disabled or true for enabled.
152
155
  # @param [String] auth_username Webhook HTTP user. Max length: 255 chars.
153
156
  # @param [String] auth_password Webhook HTTP password. Max length: 2048 chars. Omit to keep the current password; it is cleared when the URL changes or TLS verification is disabled.
157
+ # @param [String] description Optional description for the webhook.
154
158
  #
155
159
  # @return [Webhook]
156
160
  def update(
@@ -161,7 +165,8 @@ module Appwrite
161
165
  enabled: nil,
162
166
  tls: nil,
163
167
  auth_username: nil,
164
- auth_password: nil
168
+ auth_password: nil,
169
+ description: nil
165
170
  )
166
171
  if webhook_id.nil? || webhook_id == ''
167
172
  raise Appwrite::Exception.new('Missing required parameter: "webhookId"')
@@ -190,6 +195,7 @@ module Appwrite
190
195
  tls: tls,
191
196
  authUsername: auth_username,
192
197
  authPassword: auth_password,
198
+ description: description,
193
199
  }
194
200
 
195
201
  api_headers = {
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: appwrite
3
3
  version: !ruby/object:Gem::Version
4
- version: 29.0.0
4
+ version: 30.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Appwrite Team
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-10-15 00:00:00.000000000 Z
11
+ date: 2026-10-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: mime-types
@@ -491,7 +491,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
491
491
  requirements:
492
492
  - - ">="
493
493
  - !ruby/object:Gem::Version
494
- version: '0'
494
+ version: '2.7'
495
495
  required_rubygems_version: !ruby/object:Gem::Requirement
496
496
  requirements:
497
497
  - - ">="