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.
- checksums.yaml +4 -4
- data/lib/appwrite/client.rb +3 -3
- data/lib/appwrite/models/attribute_bigint.rb +6 -1
- data/lib/appwrite/models/attribute_boolean.rb +6 -1
- data/lib/appwrite/models/attribute_datetime.rb +6 -1
- data/lib/appwrite/models/attribute_email.rb +6 -1
- data/lib/appwrite/models/attribute_enum.rb +6 -1
- data/lib/appwrite/models/attribute_float.rb +6 -1
- data/lib/appwrite/models/attribute_integer.rb +6 -1
- data/lib/appwrite/models/attribute_ip.rb +6 -1
- data/lib/appwrite/models/attribute_line.rb +6 -1
- data/lib/appwrite/models/attribute_longtext.rb +6 -1
- data/lib/appwrite/models/attribute_mediumtext.rb +6 -1
- data/lib/appwrite/models/attribute_object.rb +6 -1
- data/lib/appwrite/models/attribute_point.rb +6 -1
- data/lib/appwrite/models/attribute_polygon.rb +6 -1
- data/lib/appwrite/models/attribute_relationship.rb +6 -1
- data/lib/appwrite/models/attribute_string.rb +6 -1
- data/lib/appwrite/models/attribute_text.rb +6 -1
- data/lib/appwrite/models/attribute_url.rb +6 -1
- data/lib/appwrite/models/attribute_varchar.rb +6 -1
- data/lib/appwrite/models/attribute_vector.rb +6 -1
- data/lib/appwrite/models/billing_plan.rb +6 -1
- data/lib/appwrite/models/bucket.rb +11 -1
- data/lib/appwrite/models/collection.rb +6 -1
- data/lib/appwrite/models/column_bigint.rb +6 -1
- data/lib/appwrite/models/column_boolean.rb +6 -1
- data/lib/appwrite/models/column_datetime.rb +6 -1
- data/lib/appwrite/models/column_email.rb +6 -1
- data/lib/appwrite/models/column_enum.rb +6 -1
- data/lib/appwrite/models/column_float.rb +6 -1
- data/lib/appwrite/models/column_index.rb +6 -1
- data/lib/appwrite/models/column_integer.rb +6 -1
- data/lib/appwrite/models/column_ip.rb +6 -1
- data/lib/appwrite/models/column_line.rb +6 -1
- data/lib/appwrite/models/column_longtext.rb +6 -1
- data/lib/appwrite/models/column_mediumtext.rb +6 -1
- data/lib/appwrite/models/column_point.rb +6 -1
- data/lib/appwrite/models/column_polygon.rb +6 -1
- data/lib/appwrite/models/column_relationship.rb +6 -1
- data/lib/appwrite/models/column_string.rb +6 -1
- data/lib/appwrite/models/column_text.rb +6 -1
- data/lib/appwrite/models/column_url.rb +6 -1
- data/lib/appwrite/models/column_varchar.rb +6 -1
- data/lib/appwrite/models/database.rb +6 -1
- data/lib/appwrite/models/ephemeral_key.rb +6 -1
- data/lib/appwrite/models/function.rb +6 -1
- data/lib/appwrite/models/index.rb +6 -1
- data/lib/appwrite/models/key.rb +6 -1
- data/lib/appwrite/models/policy_password_dictionary.rb +9 -4
- data/lib/appwrite/models/policy_password_personal_data.rb +9 -4
- data/lib/appwrite/models/site.rb +6 -1
- data/lib/appwrite/models/table.rb +6 -1
- data/lib/appwrite/models/topic.rb +6 -1
- data/lib/appwrite/models/variable.rb +6 -1
- data/lib/appwrite/models/vectorsdb_collection.rb +6 -1
- data/lib/appwrite/models/webhook.rb +6 -1
- data/lib/appwrite/services/account.rb +48 -0
- data/lib/appwrite/services/activities.rb +4 -1
- data/lib/appwrite/services/backups.rb +12 -3
- data/lib/appwrite/services/databases.rb +233 -42
- data/lib/appwrite/services/documents_db.rb +74 -3
- data/lib/appwrite/services/domains.rb +8 -2
- data/lib/appwrite/services/functions.rb +15 -3
- data/lib/appwrite/services/messaging.rb +16 -4
- data/lib/appwrite/services/mongo.rb +12 -3
- data/lib/appwrite/services/mysql.rb +12 -3
- data/lib/appwrite/services/organization.rb +4 -1
- data/lib/appwrite/services/postgresql.rb +12 -3
- data/lib/appwrite/services/project.rb +38 -5
- data/lib/appwrite/services/sites.rb +16 -4
- data/lib/appwrite/services/storage.rb +15 -3
- data/lib/appwrite/services/tables_db.rb +227 -40
- data/lib/appwrite/services/vectors_db.rb +18 -3
- data/lib/appwrite/services/webhooks.rb +8 -2
- 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,
|
|
@@ -484,6 +490,7 @@ module Appwrite
|
|
|
484
490
|
# @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.
|
|
485
491
|
# @param [Array] attributes Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
486
492
|
# @param [Array] indexes Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
493
|
+
# @param [String] description Optional description for the collection.
|
|
487
494
|
#
|
|
488
495
|
# @return [Collection]
|
|
489
496
|
def create_collection(
|
|
@@ -494,7 +501,8 @@ module Appwrite
|
|
|
494
501
|
document_security: nil,
|
|
495
502
|
enabled: nil,
|
|
496
503
|
attributes: nil,
|
|
497
|
-
indexes: nil
|
|
504
|
+
indexes: nil,
|
|
505
|
+
description: nil
|
|
498
506
|
)
|
|
499
507
|
if database_id.nil? || database_id == ''
|
|
500
508
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -519,6 +527,7 @@ module Appwrite
|
|
|
519
527
|
enabled: enabled,
|
|
520
528
|
attributes: attributes,
|
|
521
529
|
indexes: indexes,
|
|
530
|
+
description: description,
|
|
522
531
|
}
|
|
523
532
|
|
|
524
533
|
api_headers = {
|
|
@@ -584,6 +593,7 @@ module Appwrite
|
|
|
584
593
|
# @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).
|
|
585
594
|
# @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.
|
|
586
595
|
# @param [] purge When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
|
|
596
|
+
# @param [String] description Optional description for the collection.
|
|
587
597
|
#
|
|
588
598
|
# @return [Collection]
|
|
589
599
|
def update_collection(
|
|
@@ -593,7 +603,8 @@ module Appwrite
|
|
|
593
603
|
permissions: nil,
|
|
594
604
|
document_security: nil,
|
|
595
605
|
enabled: nil,
|
|
596
|
-
purge: nil
|
|
606
|
+
purge: nil,
|
|
607
|
+
description: nil
|
|
597
608
|
)
|
|
598
609
|
if database_id.nil? || database_id == ''
|
|
599
610
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -617,6 +628,7 @@ module Appwrite
|
|
|
617
628
|
documentSecurity: document_security,
|
|
618
629
|
enabled: enabled,
|
|
619
630
|
purge: purge,
|
|
631
|
+
description: description,
|
|
620
632
|
}
|
|
621
633
|
|
|
622
634
|
api_headers = {
|
|
@@ -993,6 +1005,62 @@ module Appwrite
|
|
|
993
1005
|
)
|
|
994
1006
|
end
|
|
995
1007
|
|
|
1008
|
+
# Get a list of all the user's documents in a given collection using a POST
|
|
1009
|
+
# request. This behaves identically to the list documents endpoint but
|
|
1010
|
+
# accepts the queries in the request body, allowing much larger `queries`
|
|
1011
|
+
# arrays than can fit in a URL query string.
|
|
1012
|
+
#
|
|
1013
|
+
#
|
|
1014
|
+
# @param [String] database_id Database ID.
|
|
1015
|
+
# @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1016
|
+
# @param [Array] 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.
|
|
1017
|
+
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
1018
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1019
|
+
# @param [Integer] ttl TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
1020
|
+
#
|
|
1021
|
+
# @return [DocumentList]
|
|
1022
|
+
def create_query(
|
|
1023
|
+
database_id:,
|
|
1024
|
+
collection_id:,
|
|
1025
|
+
queries: nil,
|
|
1026
|
+
transaction_id: nil,
|
|
1027
|
+
total: nil,
|
|
1028
|
+
ttl: nil
|
|
1029
|
+
)
|
|
1030
|
+
if database_id.nil? || database_id == ''
|
|
1031
|
+
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
1032
|
+
end
|
|
1033
|
+
|
|
1034
|
+
if collection_id.nil? || collection_id == ''
|
|
1035
|
+
raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
|
|
1036
|
+
end
|
|
1037
|
+
|
|
1038
|
+
api_path = '/documentsdb/{databaseId}/collections/{collectionId}/documents/query'
|
|
1039
|
+
.gsub('{databaseId}', database_id)
|
|
1040
|
+
.gsub('{collectionId}', collection_id)
|
|
1041
|
+
|
|
1042
|
+
api_params = {
|
|
1043
|
+
queries: queries,
|
|
1044
|
+
transactionId: transaction_id,
|
|
1045
|
+
total: total,
|
|
1046
|
+
ttl: ttl,
|
|
1047
|
+
}
|
|
1048
|
+
|
|
1049
|
+
api_headers = {
|
|
1050
|
+
"X-Appwrite-Project": @client.get_config('project'),
|
|
1051
|
+
"content-type": 'application/json',
|
|
1052
|
+
"accept": 'application/json',
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
@client.call(
|
|
1056
|
+
method: 'POST',
|
|
1057
|
+
path: api_path,
|
|
1058
|
+
headers: api_headers,
|
|
1059
|
+
params: api_params,
|
|
1060
|
+
response_type: Models::DocumentList
|
|
1061
|
+
)
|
|
1062
|
+
end
|
|
1063
|
+
|
|
996
1064
|
# Get a document by its unique ID. This endpoint response returns a JSON
|
|
997
1065
|
# object with the document data.
|
|
998
1066
|
#
|
|
@@ -1393,6 +1461,7 @@ module Appwrite
|
|
|
1393
1461
|
# @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
1394
1462
|
# @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
|
|
1395
1463
|
# @param [Array] lengths Length of index. Maximum of 100
|
|
1464
|
+
# @param [String] description Optional description for the index.
|
|
1396
1465
|
#
|
|
1397
1466
|
# @return [Index]
|
|
1398
1467
|
def create_index(
|
|
@@ -1402,7 +1471,8 @@ module Appwrite
|
|
|
1402
1471
|
type:,
|
|
1403
1472
|
attributes:,
|
|
1404
1473
|
orders: nil,
|
|
1405
|
-
lengths: nil
|
|
1474
|
+
lengths: nil,
|
|
1475
|
+
description: nil
|
|
1406
1476
|
)
|
|
1407
1477
|
if database_id.nil? || database_id == ''
|
|
1408
1478
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1434,6 +1504,7 @@ module Appwrite
|
|
|
1434
1504
|
attributes: attributes,
|
|
1435
1505
|
orders: orders,
|
|
1436
1506
|
lengths: lengths,
|
|
1507
|
+
description: description,
|
|
1437
1508
|
}
|
|
1438
1509
|
|
|
1439
1510
|
api_headers = {
|
|
@@ -11,17 +11,20 @@ module Appwrite
|
|
|
11
11
|
#
|
|
12
12
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.
|
|
13
13
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
14
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
14
15
|
#
|
|
15
16
|
# @return [DomainsList]
|
|
16
17
|
def list(
|
|
17
18
|
queries: nil,
|
|
18
|
-
search: nil
|
|
19
|
+
search: nil,
|
|
20
|
+
total: nil
|
|
19
21
|
)
|
|
20
22
|
api_path = '/domains'
|
|
21
23
|
|
|
22
24
|
api_params = {
|
|
23
25
|
queries: queries,
|
|
24
26
|
search: search,
|
|
27
|
+
total: total,
|
|
25
28
|
}
|
|
26
29
|
|
|
27
30
|
api_headers = {
|
|
@@ -701,11 +704,13 @@ module Appwrite
|
|
|
701
704
|
#
|
|
702
705
|
# @param [String] domain_id Domain unique ID.
|
|
703
706
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
707
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
704
708
|
#
|
|
705
709
|
# @return [DnsRecordsList]
|
|
706
710
|
def list_records(
|
|
707
711
|
domain_id:,
|
|
708
|
-
queries: nil
|
|
712
|
+
queries: nil,
|
|
713
|
+
total: nil
|
|
709
714
|
)
|
|
710
715
|
if domain_id.nil? || domain_id == ''
|
|
711
716
|
raise Appwrite::Exception.new('Missing required parameter: "domainId"')
|
|
@@ -716,6 +721,7 @@ module Appwrite
|
|
|
716
721
|
|
|
717
722
|
api_params = {
|
|
718
723
|
queries: queries,
|
|
724
|
+
total: total,
|
|
719
725
|
}
|
|
720
726
|
|
|
721
727
|
api_headers = {
|
|
@@ -69,6 +69,7 @@ module Appwrite
|
|
|
69
69
|
# @param [String] runtime_specification Runtime specification for the function executions.
|
|
70
70
|
# @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
71
71
|
# @param [Integer] interval Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule.
|
|
72
|
+
# @param [String] description Optional description for the function.
|
|
72
73
|
#
|
|
73
74
|
# @return [Function]
|
|
74
75
|
def create(
|
|
@@ -94,7 +95,8 @@ module Appwrite
|
|
|
94
95
|
build_specification: nil,
|
|
95
96
|
runtime_specification: nil,
|
|
96
97
|
deployment_retention: nil,
|
|
97
|
-
interval: nil
|
|
98
|
+
interval: nil,
|
|
99
|
+
description: nil
|
|
98
100
|
)
|
|
99
101
|
if function_id.nil?
|
|
100
102
|
raise Appwrite::Exception.new('Missing required parameter: "functionId"')
|
|
@@ -134,6 +136,7 @@ module Appwrite
|
|
|
134
136
|
runtimeSpecification: runtime_specification,
|
|
135
137
|
deploymentRetention: deployment_retention,
|
|
136
138
|
interval: interval,
|
|
139
|
+
description: description,
|
|
137
140
|
}
|
|
138
141
|
|
|
139
142
|
api_headers = {
|
|
@@ -266,6 +269,7 @@ module Appwrite
|
|
|
266
269
|
# @param [String] runtime_specification Runtime specification for the function executions.
|
|
267
270
|
# @param [Integer] deployment_retention Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
|
|
268
271
|
# @param [Integer] interval Minutes between scheduled executions. Appwrite picks when within each interval the function runs. Use 0 to disable. Cannot be combined with schedule. When omitted, the current interval is kept unless schedule is set.
|
|
272
|
+
# @param [String] description Optional description for the function.
|
|
269
273
|
# @param [] email_enabled Enable inbound email triggering for this function. When false or omitted on create, SMTP recipients are rejected. Opt-in; default is off.
|
|
270
274
|
#
|
|
271
275
|
# @return [Function]
|
|
@@ -293,6 +297,7 @@ module Appwrite
|
|
|
293
297
|
runtime_specification: nil,
|
|
294
298
|
deployment_retention: nil,
|
|
295
299
|
interval: nil,
|
|
300
|
+
description: nil,
|
|
296
301
|
email_enabled: nil
|
|
297
302
|
)
|
|
298
303
|
if function_id.nil? || function_id == ''
|
|
@@ -329,6 +334,7 @@ module Appwrite
|
|
|
329
334
|
runtimeSpecification: runtime_specification,
|
|
330
335
|
deploymentRetention: deployment_retention,
|
|
331
336
|
interval: interval,
|
|
337
|
+
description: description,
|
|
332
338
|
emailEnabled: email_enabled,
|
|
333
339
|
}
|
|
334
340
|
|
|
@@ -1084,6 +1090,7 @@ module Appwrite
|
|
|
1084
1090
|
# @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
|
|
1085
1091
|
# @param [String] value Variable value. Max length: 8192 chars.
|
|
1086
1092
|
# @param [] secret Secret variables can be updated or deleted, but only functions can read them during build and runtime.
|
|
1093
|
+
# @param [String] description Optional description for the variable.
|
|
1087
1094
|
#
|
|
1088
1095
|
# @return [Variable]
|
|
1089
1096
|
def create_variable(
|
|
@@ -1091,7 +1098,8 @@ module Appwrite
|
|
|
1091
1098
|
variable_id:,
|
|
1092
1099
|
key:,
|
|
1093
1100
|
value:,
|
|
1094
|
-
secret: nil
|
|
1101
|
+
secret: nil,
|
|
1102
|
+
description: nil
|
|
1095
1103
|
)
|
|
1096
1104
|
if function_id.nil? || function_id == ''
|
|
1097
1105
|
raise Appwrite::Exception.new('Missing required parameter: "functionId"')
|
|
@@ -1117,6 +1125,7 @@ module Appwrite
|
|
|
1117
1125
|
key: key,
|
|
1118
1126
|
value: value,
|
|
1119
1127
|
secret: secret,
|
|
1128
|
+
description: description,
|
|
1120
1129
|
}
|
|
1121
1130
|
|
|
1122
1131
|
api_headers = {
|
|
@@ -1179,6 +1188,7 @@ module Appwrite
|
|
|
1179
1188
|
# @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
|
|
1180
1189
|
# @param [String] value Variable value. Max length: 8192 chars.
|
|
1181
1190
|
# @param [] secret Secret variables can be updated or deleted, but only functions can read them during build and runtime.
|
|
1191
|
+
# @param [String] description Optional description for the variable.
|
|
1182
1192
|
#
|
|
1183
1193
|
# @return [Variable]
|
|
1184
1194
|
def update_variable(
|
|
@@ -1186,7 +1196,8 @@ module Appwrite
|
|
|
1186
1196
|
variable_id:,
|
|
1187
1197
|
key: nil,
|
|
1188
1198
|
value: nil,
|
|
1189
|
-
secret: nil
|
|
1199
|
+
secret: nil,
|
|
1200
|
+
description: nil
|
|
1190
1201
|
)
|
|
1191
1202
|
if function_id.nil? || function_id == ''
|
|
1192
1203
|
raise Appwrite::Exception.new('Missing required parameter: "functionId"')
|
|
@@ -1204,6 +1215,7 @@ module Appwrite
|
|
|
1204
1215
|
key: key,
|
|
1205
1216
|
value: value,
|
|
1206
1217
|
secret: secret,
|
|
1218
|
+
description: description,
|
|
1207
1219
|
}
|
|
1208
1220
|
|
|
1209
1221
|
api_headers = {
|
|
@@ -56,6 +56,7 @@ module Appwrite
|
|
|
56
56
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
|
57
57
|
# @param [String] reply_to_email Email address to reply to. If not set, defaults to the sender email address.
|
|
58
58
|
# @param [String] reply_to_name Name of the reply to recipient. If not set, defaults to the sender name.
|
|
59
|
+
# @param [Array] emails List of email addresses to send the message to. Use this to deliver to recipients that are not backed by an Appwrite user, target, or topic.
|
|
59
60
|
#
|
|
60
61
|
# @return [Message]
|
|
61
62
|
def create_email(
|
|
@@ -72,7 +73,8 @@ module Appwrite
|
|
|
72
73
|
html: nil,
|
|
73
74
|
scheduled_at: nil,
|
|
74
75
|
reply_to_email: nil,
|
|
75
|
-
reply_to_name: nil
|
|
76
|
+
reply_to_name: nil,
|
|
77
|
+
emails: nil
|
|
76
78
|
)
|
|
77
79
|
if message_id.nil?
|
|
78
80
|
raise Appwrite::Exception.new('Missing required parameter: "messageId"')
|
|
@@ -103,6 +105,7 @@ module Appwrite
|
|
|
103
105
|
scheduledAt: scheduled_at,
|
|
104
106
|
replyToEmail: reply_to_email,
|
|
105
107
|
replyToName: reply_to_name,
|
|
108
|
+
emails: emails,
|
|
106
109
|
}
|
|
107
110
|
|
|
108
111
|
api_headers = {
|
|
@@ -139,6 +142,7 @@ module Appwrite
|
|
|
139
142
|
# @param [Array] attachments Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.
|
|
140
143
|
# @param [String] reply_to_email Email address to reply to. Pass an empty string to restore the provider or sender default.
|
|
141
144
|
# @param [String] reply_to_name Name of the reply to recipient. Pass an empty string to restore the provider or sender default.
|
|
145
|
+
# @param [Array] emails List of email addresses to send the message to. Use this to deliver to recipients that are not backed by an Appwrite user, target, or topic.
|
|
142
146
|
#
|
|
143
147
|
# @return [Message]
|
|
144
148
|
def update_email(
|
|
@@ -155,7 +159,8 @@ module Appwrite
|
|
|
155
159
|
scheduled_at: nil,
|
|
156
160
|
attachments: nil,
|
|
157
161
|
reply_to_email: nil,
|
|
158
|
-
reply_to_name: nil
|
|
162
|
+
reply_to_name: nil,
|
|
163
|
+
emails: nil
|
|
159
164
|
)
|
|
160
165
|
if message_id.nil? || message_id == ''
|
|
161
166
|
raise Appwrite::Exception.new('Missing required parameter: "messageId"')
|
|
@@ -178,6 +183,7 @@ module Appwrite
|
|
|
178
183
|
attachments: attachments,
|
|
179
184
|
replyToEmail: reply_to_email,
|
|
180
185
|
replyToName: reply_to_name,
|
|
186
|
+
emails: emails,
|
|
181
187
|
}
|
|
182
188
|
|
|
183
189
|
api_headers = {
|
|
@@ -2145,6 +2151,7 @@ module Appwrite
|
|
|
2145
2151
|
# @param [Array] subscribe An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
2146
2152
|
# @param [Integer] qos MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
2147
2153
|
# @param [Integer] expiry Message retention in seconds for offline delivery. Max 7 days (604800). Null inherits the lowest expiry of the project's enabled Appwrite providers, or the 7-day ledger window if none sets one.
|
|
2154
|
+
# @param [String] description Optional description for the topic.
|
|
2148
2155
|
#
|
|
2149
2156
|
# @return [Topic]
|
|
2150
2157
|
def create_topic(
|
|
@@ -2152,7 +2159,8 @@ module Appwrite
|
|
|
2152
2159
|
name:,
|
|
2153
2160
|
subscribe: nil,
|
|
2154
2161
|
qos: nil,
|
|
2155
|
-
expiry: nil
|
|
2162
|
+
expiry: nil,
|
|
2163
|
+
description: nil
|
|
2156
2164
|
)
|
|
2157
2165
|
if topic_id.nil?
|
|
2158
2166
|
raise Appwrite::Exception.new('Missing required parameter: "topicId"')
|
|
@@ -2170,6 +2178,7 @@ module Appwrite
|
|
|
2170
2178
|
subscribe: subscribe,
|
|
2171
2179
|
qos: qos,
|
|
2172
2180
|
expiry: expiry,
|
|
2181
|
+
description: description,
|
|
2173
2182
|
}
|
|
2174
2183
|
|
|
2175
2184
|
api_headers = {
|
|
@@ -2227,6 +2236,7 @@ module Appwrite
|
|
|
2227
2236
|
# @param [Array] subscribe An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
2228
2237
|
# @param [Integer] qos MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
2229
2238
|
# @param [Integer] expiry Message retention in seconds for offline delivery. Max 7 days (604800). Null inherits the lowest expiry of the project's enabled Appwrite providers, or the 7-day ledger window if none sets one.
|
|
2239
|
+
# @param [String] description Optional description for the topic.
|
|
2230
2240
|
#
|
|
2231
2241
|
# @return [Topic]
|
|
2232
2242
|
def update_topic(
|
|
@@ -2234,7 +2244,8 @@ module Appwrite
|
|
|
2234
2244
|
name: nil,
|
|
2235
2245
|
subscribe: nil,
|
|
2236
2246
|
qos: nil,
|
|
2237
|
-
expiry: nil
|
|
2247
|
+
expiry: nil,
|
|
2248
|
+
description: nil
|
|
2238
2249
|
)
|
|
2239
2250
|
if topic_id.nil? || topic_id == ''
|
|
2240
2251
|
raise Appwrite::Exception.new('Missing required parameter: "topicId"')
|
|
@@ -2248,6 +2259,7 @@ module Appwrite
|
|
|
2248
2259
|
subscribe: subscribe,
|
|
2249
2260
|
qos: qos,
|
|
2250
2261
|
expiry: expiry,
|
|
2262
|
+
description: description,
|
|
2251
2263
|
}
|
|
2252
2264
|
|
|
2253
2265
|
api_headers = {
|
|
@@ -9,15 +9,18 @@ module Appwrite
|
|
|
9
9
|
# List all dedicated databases. Results support pagination.
|
|
10
10
|
#
|
|
11
11
|
# @param [Array] queries Array of query strings.
|
|
12
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
12
13
|
#
|
|
13
14
|
# @return [DedicatedDatabaseList]
|
|
14
15
|
def list(
|
|
15
|
-
queries: nil
|
|
16
|
+
queries: nil,
|
|
17
|
+
total: nil
|
|
16
18
|
)
|
|
17
19
|
api_path = '/mongo'
|
|
18
20
|
|
|
19
21
|
api_params = {
|
|
20
22
|
queries: queries,
|
|
23
|
+
total: total,
|
|
21
24
|
}
|
|
22
25
|
|
|
23
26
|
api_headers = {
|
|
@@ -303,11 +306,13 @@ module Appwrite
|
|
|
303
306
|
#
|
|
304
307
|
# @param [String] database_id Database ID.
|
|
305
308
|
# @param [Array] 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: status, type, databaseId
|
|
309
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
306
310
|
#
|
|
307
311
|
# @return [DedicatedDatabaseBackupList]
|
|
308
312
|
def list_backups(
|
|
309
313
|
database_id:,
|
|
310
|
-
queries: nil
|
|
314
|
+
queries: nil,
|
|
315
|
+
total: nil
|
|
311
316
|
)
|
|
312
317
|
if database_id.nil? || database_id == ''
|
|
313
318
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -318,6 +323,7 @@ module Appwrite
|
|
|
318
323
|
|
|
319
324
|
api_params = {
|
|
320
325
|
queries: queries,
|
|
326
|
+
total: total,
|
|
321
327
|
}
|
|
322
328
|
|
|
323
329
|
api_headers = {
|
|
@@ -375,11 +381,13 @@ module Appwrite
|
|
|
375
381
|
#
|
|
376
382
|
# @param [String] database_id Database ID.
|
|
377
383
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK.
|
|
384
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
378
385
|
#
|
|
379
386
|
# @return [BackupPolicyList]
|
|
380
387
|
def list_backup_policies(
|
|
381
388
|
database_id:,
|
|
382
|
-
queries: nil
|
|
389
|
+
queries: nil,
|
|
390
|
+
total: nil
|
|
383
391
|
)
|
|
384
392
|
if database_id.nil? || database_id == ''
|
|
385
393
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -390,6 +398,7 @@ module Appwrite
|
|
|
390
398
|
|
|
391
399
|
api_params = {
|
|
392
400
|
queries: queries,
|
|
401
|
+
total: total,
|
|
393
402
|
}
|
|
394
403
|
|
|
395
404
|
api_headers = {
|
|
@@ -9,15 +9,18 @@ module Appwrite
|
|
|
9
9
|
# List all dedicated databases. Results support pagination.
|
|
10
10
|
#
|
|
11
11
|
# @param [Array] queries Array of query strings.
|
|
12
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
12
13
|
#
|
|
13
14
|
# @return [DedicatedDatabaseList]
|
|
14
15
|
def list(
|
|
15
|
-
queries: nil
|
|
16
|
+
queries: nil,
|
|
17
|
+
total: nil
|
|
16
18
|
)
|
|
17
19
|
api_path = '/mysql'
|
|
18
20
|
|
|
19
21
|
api_params = {
|
|
20
22
|
queries: queries,
|
|
23
|
+
total: total,
|
|
21
24
|
}
|
|
22
25
|
|
|
23
26
|
api_headers = {
|
|
@@ -303,11 +306,13 @@ module Appwrite
|
|
|
303
306
|
#
|
|
304
307
|
# @param [String] database_id Database ID.
|
|
305
308
|
# @param [Array] 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: status, type, databaseId
|
|
309
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
306
310
|
#
|
|
307
311
|
# @return [DedicatedDatabaseBackupList]
|
|
308
312
|
def list_backups(
|
|
309
313
|
database_id:,
|
|
310
|
-
queries: nil
|
|
314
|
+
queries: nil,
|
|
315
|
+
total: nil
|
|
311
316
|
)
|
|
312
317
|
if database_id.nil? || database_id == ''
|
|
313
318
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -318,6 +323,7 @@ module Appwrite
|
|
|
318
323
|
|
|
319
324
|
api_params = {
|
|
320
325
|
queries: queries,
|
|
326
|
+
total: total,
|
|
321
327
|
}
|
|
322
328
|
|
|
323
329
|
api_headers = {
|
|
@@ -375,11 +381,13 @@ module Appwrite
|
|
|
375
381
|
#
|
|
376
382
|
# @param [String] database_id Database ID.
|
|
377
383
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK.
|
|
384
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
378
385
|
#
|
|
379
386
|
# @return [BackupPolicyList]
|
|
380
387
|
def list_backup_policies(
|
|
381
388
|
database_id:,
|
|
382
|
-
queries: nil
|
|
389
|
+
queries: nil,
|
|
390
|
+
total: nil
|
|
383
391
|
)
|
|
384
392
|
if database_id.nil? || database_id == ''
|
|
385
393
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -390,6 +398,7 @@ module Appwrite
|
|
|
390
398
|
|
|
391
399
|
api_params = {
|
|
392
400
|
queries: queries,
|
|
401
|
+
total: total,
|
|
393
402
|
}
|
|
394
403
|
|
|
395
404
|
api_headers = {
|
|
@@ -764,6 +764,7 @@ module Appwrite
|
|
|
764
764
|
# @param [String] name Key name. Max length: 128 chars.
|
|
765
765
|
# @param [Array] scopes Key scopes list. Maximum of 200 scopes are allowed.
|
|
766
766
|
# @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.
|
|
767
|
+
# @param [String] description Optional description for the key.
|
|
767
768
|
#
|
|
768
769
|
# @return [Key]
|
|
769
770
|
def update_project_key(
|
|
@@ -771,7 +772,8 @@ module Appwrite
|
|
|
771
772
|
key_id:,
|
|
772
773
|
name:,
|
|
773
774
|
scopes:,
|
|
774
|
-
expire: nil
|
|
775
|
+
expire: nil,
|
|
776
|
+
description: nil
|
|
775
777
|
)
|
|
776
778
|
if project_id.nil? || project_id == ''
|
|
777
779
|
raise Appwrite::Exception.new('Missing required parameter: "projectId"')
|
|
@@ -797,6 +799,7 @@ module Appwrite
|
|
|
797
799
|
name: name,
|
|
798
800
|
scopes: scopes,
|
|
799
801
|
expire: expire,
|
|
802
|
+
description: description,
|
|
800
803
|
}
|
|
801
804
|
|
|
802
805
|
api_headers = {
|
|
@@ -9,15 +9,18 @@ module Appwrite
|
|
|
9
9
|
# List all dedicated databases. Results support pagination.
|
|
10
10
|
#
|
|
11
11
|
# @param [Array] queries Array of query strings.
|
|
12
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
12
13
|
#
|
|
13
14
|
# @return [DedicatedDatabaseList]
|
|
14
15
|
def list(
|
|
15
|
-
queries: nil
|
|
16
|
+
queries: nil,
|
|
17
|
+
total: nil
|
|
16
18
|
)
|
|
17
19
|
api_path = '/postgresql'
|
|
18
20
|
|
|
19
21
|
api_params = {
|
|
20
22
|
queries: queries,
|
|
23
|
+
total: total,
|
|
21
24
|
}
|
|
22
25
|
|
|
23
26
|
api_headers = {
|
|
@@ -303,11 +306,13 @@ module Appwrite
|
|
|
303
306
|
#
|
|
304
307
|
# @param [String] database_id Database ID.
|
|
305
308
|
# @param [Array] 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: status, type, databaseId
|
|
309
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
306
310
|
#
|
|
307
311
|
# @return [DedicatedDatabaseBackupList]
|
|
308
312
|
def list_backups(
|
|
309
313
|
database_id:,
|
|
310
|
-
queries: nil
|
|
314
|
+
queries: nil,
|
|
315
|
+
total: nil
|
|
311
316
|
)
|
|
312
317
|
if database_id.nil? || database_id == ''
|
|
313
318
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -318,6 +323,7 @@ module Appwrite
|
|
|
318
323
|
|
|
319
324
|
api_params = {
|
|
320
325
|
queries: queries,
|
|
326
|
+
total: total,
|
|
321
327
|
}
|
|
322
328
|
|
|
323
329
|
api_headers = {
|
|
@@ -375,11 +381,13 @@ module Appwrite
|
|
|
375
381
|
#
|
|
376
382
|
# @param [String] database_id Database ID.
|
|
377
383
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK.
|
|
384
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
378
385
|
#
|
|
379
386
|
# @return [BackupPolicyList]
|
|
380
387
|
def list_backup_policies(
|
|
381
388
|
database_id:,
|
|
382
|
-
queries: nil
|
|
389
|
+
queries: nil,
|
|
390
|
+
total: nil
|
|
383
391
|
)
|
|
384
392
|
if database_id.nil? || database_id == ''
|
|
385
393
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -390,6 +398,7 @@ module Appwrite
|
|
|
390
398
|
|
|
391
399
|
api_params = {
|
|
392
400
|
queries: queries,
|
|
401
|
+
total: total,
|
|
393
402
|
}
|
|
394
403
|
|
|
395
404
|
api_headers = {
|