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
|
@@ -53,12 +53,14 @@ module Appwrite
|
|
|
53
53
|
# @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.
|
|
54
54
|
# @param [String] name Database name. Max length: 128 chars.
|
|
55
55
|
# @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.
|
|
56
|
+
# @param [String] description Optional description for the database.
|
|
56
57
|
#
|
|
57
58
|
# @return [Database]
|
|
58
59
|
def create(
|
|
59
60
|
database_id:,
|
|
60
61
|
name:,
|
|
61
|
-
enabled: nil
|
|
62
|
+
enabled: nil,
|
|
63
|
+
description: nil
|
|
62
64
|
)
|
|
63
65
|
if database_id.nil?
|
|
64
66
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -74,6 +76,7 @@ module Appwrite
|
|
|
74
76
|
databaseId: database_id,
|
|
75
77
|
name: name,
|
|
76
78
|
enabled: enabled,
|
|
79
|
+
description: description,
|
|
77
80
|
}
|
|
78
81
|
|
|
79
82
|
api_headers = {
|
|
@@ -349,12 +352,14 @@ module Appwrite
|
|
|
349
352
|
# @param [String] database_id Database ID.
|
|
350
353
|
# @param [String] name Database name. Max length: 128 chars.
|
|
351
354
|
# @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.
|
|
355
|
+
# @param [String] description Optional description for the database.
|
|
352
356
|
#
|
|
353
357
|
# @return [Database]
|
|
354
358
|
def update(
|
|
355
359
|
database_id:,
|
|
356
360
|
name: nil,
|
|
357
|
-
enabled: nil
|
|
361
|
+
enabled: nil,
|
|
362
|
+
description: nil
|
|
358
363
|
)
|
|
359
364
|
if database_id.nil? || database_id == ''
|
|
360
365
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -366,6 +371,7 @@ module Appwrite
|
|
|
366
371
|
api_params = {
|
|
367
372
|
name: name,
|
|
368
373
|
enabled: enabled,
|
|
374
|
+
description: description,
|
|
369
375
|
}
|
|
370
376
|
|
|
371
377
|
api_headers = {
|
|
@@ -479,6 +485,7 @@ module Appwrite
|
|
|
479
485
|
# @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.
|
|
480
486
|
# @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.
|
|
481
487
|
# @param [Array] indexes Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial, trigram), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
488
|
+
# @param [String] description Optional description for the collection.
|
|
482
489
|
#
|
|
483
490
|
# @return [Collection]
|
|
484
491
|
def create_collection(
|
|
@@ -489,7 +496,8 @@ module Appwrite
|
|
|
489
496
|
document_security: nil,
|
|
490
497
|
enabled: nil,
|
|
491
498
|
attributes: nil,
|
|
492
|
-
indexes: nil
|
|
499
|
+
indexes: nil,
|
|
500
|
+
description: nil
|
|
493
501
|
)
|
|
494
502
|
if database_id.nil? || database_id == ''
|
|
495
503
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -514,6 +522,7 @@ module Appwrite
|
|
|
514
522
|
enabled: enabled,
|
|
515
523
|
attributes: attributes,
|
|
516
524
|
indexes: indexes,
|
|
525
|
+
description: description,
|
|
517
526
|
}
|
|
518
527
|
|
|
519
528
|
api_headers = {
|
|
@@ -585,6 +594,7 @@ module Appwrite
|
|
|
585
594
|
# @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).
|
|
586
595
|
# @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.
|
|
587
596
|
# @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.
|
|
597
|
+
# @param [String] description Optional description for the collection.
|
|
588
598
|
#
|
|
589
599
|
# @return [Collection]
|
|
590
600
|
def update_collection(
|
|
@@ -594,7 +604,8 @@ module Appwrite
|
|
|
594
604
|
permissions: nil,
|
|
595
605
|
document_security: nil,
|
|
596
606
|
enabled: nil,
|
|
597
|
-
purge: nil
|
|
607
|
+
purge: nil,
|
|
608
|
+
description: nil
|
|
598
609
|
)
|
|
599
610
|
if database_id.nil? || database_id == ''
|
|
600
611
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -614,6 +625,7 @@ module Appwrite
|
|
|
614
625
|
documentSecurity: document_security,
|
|
615
626
|
enabled: enabled,
|
|
616
627
|
purge: purge,
|
|
628
|
+
description: description,
|
|
617
629
|
}
|
|
618
630
|
|
|
619
631
|
api_headers = {
|
|
@@ -736,6 +748,7 @@ module Appwrite
|
|
|
736
748
|
# @param [Integer] max Maximum value
|
|
737
749
|
# @param [Integer] default Default value. Cannot be set when attribute is required.
|
|
738
750
|
# @param [] array Is attribute an array?
|
|
751
|
+
# @param [String] description Optional description for the attribute.
|
|
739
752
|
#
|
|
740
753
|
# @return [AttributeBigint]
|
|
741
754
|
def create_big_int_attribute(
|
|
@@ -746,7 +759,8 @@ module Appwrite
|
|
|
746
759
|
min: nil,
|
|
747
760
|
max: nil,
|
|
748
761
|
default: nil,
|
|
749
|
-
array: nil
|
|
762
|
+
array: nil,
|
|
763
|
+
description: nil
|
|
750
764
|
)
|
|
751
765
|
if database_id.nil? || database_id == ''
|
|
752
766
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -775,6 +789,7 @@ module Appwrite
|
|
|
775
789
|
max: max,
|
|
776
790
|
default: default,
|
|
777
791
|
array: array,
|
|
792
|
+
description: description,
|
|
778
793
|
}
|
|
779
794
|
|
|
780
795
|
api_headers = {
|
|
@@ -807,6 +822,7 @@ module Appwrite
|
|
|
807
822
|
# @param [Integer] min Minimum value
|
|
808
823
|
# @param [Integer] max Maximum value
|
|
809
824
|
# @param [String] new_key New Attribute Key.
|
|
825
|
+
# @param [String] description Optional description for the attribute.
|
|
810
826
|
#
|
|
811
827
|
# @return [AttributeBigint]
|
|
812
828
|
def update_big_int_attribute(
|
|
@@ -817,7 +833,8 @@ module Appwrite
|
|
|
817
833
|
default:,
|
|
818
834
|
min: nil,
|
|
819
835
|
max: nil,
|
|
820
|
-
new_key: nil
|
|
836
|
+
new_key: nil,
|
|
837
|
+
description: nil
|
|
821
838
|
)
|
|
822
839
|
if database_id.nil? || database_id == ''
|
|
823
840
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -850,6 +867,7 @@ module Appwrite
|
|
|
850
867
|
max: max,
|
|
851
868
|
default: default,
|
|
852
869
|
newKey: new_key,
|
|
870
|
+
description: description,
|
|
853
871
|
}
|
|
854
872
|
|
|
855
873
|
api_headers = {
|
|
@@ -879,6 +897,7 @@ module Appwrite
|
|
|
879
897
|
# @param [] required Is attribute required?
|
|
880
898
|
# @param [] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
881
899
|
# @param [] array Is attribute an array?
|
|
900
|
+
# @param [String] description Optional description for the attribute.
|
|
882
901
|
#
|
|
883
902
|
# @return [AttributeBoolean]
|
|
884
903
|
def create_boolean_attribute(
|
|
@@ -887,7 +906,8 @@ module Appwrite
|
|
|
887
906
|
key:,
|
|
888
907
|
required:,
|
|
889
908
|
default: nil,
|
|
890
|
-
array: nil
|
|
909
|
+
array: nil,
|
|
910
|
+
description: nil
|
|
891
911
|
)
|
|
892
912
|
if database_id.nil? || database_id == ''
|
|
893
913
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -914,6 +934,7 @@ module Appwrite
|
|
|
914
934
|
required: required,
|
|
915
935
|
default: default,
|
|
916
936
|
array: array,
|
|
937
|
+
description: description,
|
|
917
938
|
}
|
|
918
939
|
|
|
919
940
|
api_headers = {
|
|
@@ -943,6 +964,7 @@ module Appwrite
|
|
|
943
964
|
# @param [] required Is attribute required?
|
|
944
965
|
# @param [] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
945
966
|
# @param [String] new_key New attribute key.
|
|
967
|
+
# @param [String] description Optional description for the attribute.
|
|
946
968
|
#
|
|
947
969
|
# @return [AttributeBoolean]
|
|
948
970
|
def update_boolean_attribute(
|
|
@@ -951,7 +973,8 @@ module Appwrite
|
|
|
951
973
|
key:,
|
|
952
974
|
required:,
|
|
953
975
|
default:,
|
|
954
|
-
new_key: nil
|
|
976
|
+
new_key: nil,
|
|
977
|
+
description: nil
|
|
955
978
|
)
|
|
956
979
|
if database_id.nil? || database_id == ''
|
|
957
980
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -982,6 +1005,7 @@ module Appwrite
|
|
|
982
1005
|
required: required,
|
|
983
1006
|
default: default,
|
|
984
1007
|
newKey: new_key,
|
|
1008
|
+
description: description,
|
|
985
1009
|
}
|
|
986
1010
|
|
|
987
1011
|
api_headers = {
|
|
@@ -1010,6 +1034,7 @@ module Appwrite
|
|
|
1010
1034
|
# @param [] required Is attribute required?
|
|
1011
1035
|
# @param [String] default Default value for the attribute in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.
|
|
1012
1036
|
# @param [] array Is attribute an array?
|
|
1037
|
+
# @param [String] description Optional description for the attribute.
|
|
1013
1038
|
#
|
|
1014
1039
|
# @return [AttributeDatetime]
|
|
1015
1040
|
def create_datetime_attribute(
|
|
@@ -1018,7 +1043,8 @@ module Appwrite
|
|
|
1018
1043
|
key:,
|
|
1019
1044
|
required:,
|
|
1020
1045
|
default: nil,
|
|
1021
|
-
array: nil
|
|
1046
|
+
array: nil,
|
|
1047
|
+
description: nil
|
|
1022
1048
|
)
|
|
1023
1049
|
if database_id.nil? || database_id == ''
|
|
1024
1050
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1045,6 +1071,7 @@ module Appwrite
|
|
|
1045
1071
|
required: required,
|
|
1046
1072
|
default: default,
|
|
1047
1073
|
array: array,
|
|
1074
|
+
description: description,
|
|
1048
1075
|
}
|
|
1049
1076
|
|
|
1050
1077
|
api_headers = {
|
|
@@ -1074,6 +1101,7 @@ module Appwrite
|
|
|
1074
1101
|
# @param [] required Is attribute required?
|
|
1075
1102
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1076
1103
|
# @param [String] new_key New attribute key.
|
|
1104
|
+
# @param [String] description Optional description for the attribute.
|
|
1077
1105
|
#
|
|
1078
1106
|
# @return [AttributeDatetime]
|
|
1079
1107
|
def update_datetime_attribute(
|
|
@@ -1082,7 +1110,8 @@ module Appwrite
|
|
|
1082
1110
|
key:,
|
|
1083
1111
|
required:,
|
|
1084
1112
|
default:,
|
|
1085
|
-
new_key: nil
|
|
1113
|
+
new_key: nil,
|
|
1114
|
+
description: nil
|
|
1086
1115
|
)
|
|
1087
1116
|
if database_id.nil? || database_id == ''
|
|
1088
1117
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1113,6 +1142,7 @@ module Appwrite
|
|
|
1113
1142
|
required: required,
|
|
1114
1143
|
default: default,
|
|
1115
1144
|
newKey: new_key,
|
|
1145
|
+
description: description,
|
|
1116
1146
|
}
|
|
1117
1147
|
|
|
1118
1148
|
api_headers = {
|
|
@@ -1142,6 +1172,7 @@ module Appwrite
|
|
|
1142
1172
|
# @param [] required Is attribute required?
|
|
1143
1173
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1144
1174
|
# @param [] array Is attribute an array?
|
|
1175
|
+
# @param [String] description Optional description for the attribute.
|
|
1145
1176
|
#
|
|
1146
1177
|
# @return [AttributeEmail]
|
|
1147
1178
|
def create_email_attribute(
|
|
@@ -1150,7 +1181,8 @@ module Appwrite
|
|
|
1150
1181
|
key:,
|
|
1151
1182
|
required:,
|
|
1152
1183
|
default: nil,
|
|
1153
|
-
array: nil
|
|
1184
|
+
array: nil,
|
|
1185
|
+
description: nil
|
|
1154
1186
|
)
|
|
1155
1187
|
if database_id.nil? || database_id == ''
|
|
1156
1188
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1177,6 +1209,7 @@ module Appwrite
|
|
|
1177
1209
|
required: required,
|
|
1178
1210
|
default: default,
|
|
1179
1211
|
array: array,
|
|
1212
|
+
description: description,
|
|
1180
1213
|
}
|
|
1181
1214
|
|
|
1182
1215
|
api_headers = {
|
|
@@ -1207,6 +1240,7 @@ module Appwrite
|
|
|
1207
1240
|
# @param [] required Is attribute required?
|
|
1208
1241
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1209
1242
|
# @param [String] new_key New Attribute Key.
|
|
1243
|
+
# @param [String] description Optional description for the attribute.
|
|
1210
1244
|
#
|
|
1211
1245
|
# @return [AttributeEmail]
|
|
1212
1246
|
def update_email_attribute(
|
|
@@ -1215,7 +1249,8 @@ module Appwrite
|
|
|
1215
1249
|
key:,
|
|
1216
1250
|
required:,
|
|
1217
1251
|
default:,
|
|
1218
|
-
new_key: nil
|
|
1252
|
+
new_key: nil,
|
|
1253
|
+
description: nil
|
|
1219
1254
|
)
|
|
1220
1255
|
if database_id.nil? || database_id == ''
|
|
1221
1256
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1246,6 +1281,7 @@ module Appwrite
|
|
|
1246
1281
|
required: required,
|
|
1247
1282
|
default: default,
|
|
1248
1283
|
newKey: new_key,
|
|
1284
|
+
description: description,
|
|
1249
1285
|
}
|
|
1250
1286
|
|
|
1251
1287
|
api_headers = {
|
|
@@ -1277,6 +1313,7 @@ module Appwrite
|
|
|
1277
1313
|
# @param [] required Is attribute required?
|
|
1278
1314
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1279
1315
|
# @param [] array Is attribute an array?
|
|
1316
|
+
# @param [String] description Optional description for the attribute.
|
|
1280
1317
|
#
|
|
1281
1318
|
# @return [AttributeEnum]
|
|
1282
1319
|
def create_enum_attribute(
|
|
@@ -1286,7 +1323,8 @@ module Appwrite
|
|
|
1286
1323
|
elements:,
|
|
1287
1324
|
required:,
|
|
1288
1325
|
default: nil,
|
|
1289
|
-
array: nil
|
|
1326
|
+
array: nil,
|
|
1327
|
+
description: nil
|
|
1290
1328
|
)
|
|
1291
1329
|
if database_id.nil? || database_id == ''
|
|
1292
1330
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1318,6 +1356,7 @@ module Appwrite
|
|
|
1318
1356
|
required: required,
|
|
1319
1357
|
default: default,
|
|
1320
1358
|
array: array,
|
|
1359
|
+
description: description,
|
|
1321
1360
|
}
|
|
1322
1361
|
|
|
1323
1362
|
api_headers = {
|
|
@@ -1349,6 +1388,7 @@ module Appwrite
|
|
|
1349
1388
|
# @param [] required Is attribute required?
|
|
1350
1389
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1351
1390
|
# @param [String] new_key New Attribute Key.
|
|
1391
|
+
# @param [String] description Optional description for the attribute.
|
|
1352
1392
|
#
|
|
1353
1393
|
# @return [AttributeEnum]
|
|
1354
1394
|
def update_enum_attribute(
|
|
@@ -1358,7 +1398,8 @@ module Appwrite
|
|
|
1358
1398
|
elements:,
|
|
1359
1399
|
required:,
|
|
1360
1400
|
default:,
|
|
1361
|
-
new_key: nil
|
|
1401
|
+
new_key: nil,
|
|
1402
|
+
description: nil
|
|
1362
1403
|
)
|
|
1363
1404
|
if database_id.nil? || database_id == ''
|
|
1364
1405
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1394,6 +1435,7 @@ module Appwrite
|
|
|
1394
1435
|
required: required,
|
|
1395
1436
|
default: default,
|
|
1396
1437
|
newKey: new_key,
|
|
1438
|
+
description: description,
|
|
1397
1439
|
}
|
|
1398
1440
|
|
|
1399
1441
|
api_headers = {
|
|
@@ -1426,6 +1468,7 @@ module Appwrite
|
|
|
1426
1468
|
# @param [Float] max Maximum value.
|
|
1427
1469
|
# @param [Float] default Default value. Cannot be set when required.
|
|
1428
1470
|
# @param [] array Is attribute an array?
|
|
1471
|
+
# @param [String] description Optional description for the attribute.
|
|
1429
1472
|
#
|
|
1430
1473
|
# @return [AttributeFloat]
|
|
1431
1474
|
def create_float_attribute(
|
|
@@ -1436,7 +1479,8 @@ module Appwrite
|
|
|
1436
1479
|
min: nil,
|
|
1437
1480
|
max: nil,
|
|
1438
1481
|
default: nil,
|
|
1439
|
-
array: nil
|
|
1482
|
+
array: nil,
|
|
1483
|
+
description: nil
|
|
1440
1484
|
)
|
|
1441
1485
|
if database_id.nil? || database_id == ''
|
|
1442
1486
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1465,6 +1509,7 @@ module Appwrite
|
|
|
1465
1509
|
max: max,
|
|
1466
1510
|
default: default,
|
|
1467
1511
|
array: array,
|
|
1512
|
+
description: description,
|
|
1468
1513
|
}
|
|
1469
1514
|
|
|
1470
1515
|
api_headers = {
|
|
@@ -1497,6 +1542,7 @@ module Appwrite
|
|
|
1497
1542
|
# @param [Float] min Minimum value.
|
|
1498
1543
|
# @param [Float] max Maximum value.
|
|
1499
1544
|
# @param [String] new_key New Attribute Key.
|
|
1545
|
+
# @param [String] description Optional description for the attribute.
|
|
1500
1546
|
#
|
|
1501
1547
|
# @return [AttributeFloat]
|
|
1502
1548
|
def update_float_attribute(
|
|
@@ -1507,7 +1553,8 @@ module Appwrite
|
|
|
1507
1553
|
default:,
|
|
1508
1554
|
min: nil,
|
|
1509
1555
|
max: nil,
|
|
1510
|
-
new_key: nil
|
|
1556
|
+
new_key: nil,
|
|
1557
|
+
description: nil
|
|
1511
1558
|
)
|
|
1512
1559
|
if database_id.nil? || database_id == ''
|
|
1513
1560
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1540,6 +1587,7 @@ module Appwrite
|
|
|
1540
1587
|
max: max,
|
|
1541
1588
|
default: default,
|
|
1542
1589
|
newKey: new_key,
|
|
1590
|
+
description: description,
|
|
1543
1591
|
}
|
|
1544
1592
|
|
|
1545
1593
|
api_headers = {
|
|
@@ -1572,6 +1620,7 @@ module Appwrite
|
|
|
1572
1620
|
# @param [Integer] max Maximum value
|
|
1573
1621
|
# @param [Integer] default Default value. Cannot be set when attribute is required.
|
|
1574
1622
|
# @param [] array Is attribute an array?
|
|
1623
|
+
# @param [String] description Optional description for the attribute.
|
|
1575
1624
|
#
|
|
1576
1625
|
# @return [AttributeInteger]
|
|
1577
1626
|
def create_integer_attribute(
|
|
@@ -1582,7 +1631,8 @@ module Appwrite
|
|
|
1582
1631
|
min: nil,
|
|
1583
1632
|
max: nil,
|
|
1584
1633
|
default: nil,
|
|
1585
|
-
array: nil
|
|
1634
|
+
array: nil,
|
|
1635
|
+
description: nil
|
|
1586
1636
|
)
|
|
1587
1637
|
if database_id.nil? || database_id == ''
|
|
1588
1638
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1611,6 +1661,7 @@ module Appwrite
|
|
|
1611
1661
|
max: max,
|
|
1612
1662
|
default: default,
|
|
1613
1663
|
array: array,
|
|
1664
|
+
description: description,
|
|
1614
1665
|
}
|
|
1615
1666
|
|
|
1616
1667
|
api_headers = {
|
|
@@ -1643,6 +1694,7 @@ module Appwrite
|
|
|
1643
1694
|
# @param [Integer] min Minimum value
|
|
1644
1695
|
# @param [Integer] max Maximum value
|
|
1645
1696
|
# @param [String] new_key New Attribute Key.
|
|
1697
|
+
# @param [String] description Optional description for the attribute.
|
|
1646
1698
|
#
|
|
1647
1699
|
# @return [AttributeInteger]
|
|
1648
1700
|
def update_integer_attribute(
|
|
@@ -1653,7 +1705,8 @@ module Appwrite
|
|
|
1653
1705
|
default:,
|
|
1654
1706
|
min: nil,
|
|
1655
1707
|
max: nil,
|
|
1656
|
-
new_key: nil
|
|
1708
|
+
new_key: nil,
|
|
1709
|
+
description: nil
|
|
1657
1710
|
)
|
|
1658
1711
|
if database_id.nil? || database_id == ''
|
|
1659
1712
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1686,6 +1739,7 @@ module Appwrite
|
|
|
1686
1739
|
max: max,
|
|
1687
1740
|
default: default,
|
|
1688
1741
|
newKey: new_key,
|
|
1742
|
+
description: description,
|
|
1689
1743
|
}
|
|
1690
1744
|
|
|
1691
1745
|
api_headers = {
|
|
@@ -1715,6 +1769,7 @@ module Appwrite
|
|
|
1715
1769
|
# @param [] required Is attribute required?
|
|
1716
1770
|
# @param [String] default Default value. Cannot be set when attribute is required.
|
|
1717
1771
|
# @param [] array Is attribute an array?
|
|
1772
|
+
# @param [String] description Optional description for the attribute.
|
|
1718
1773
|
#
|
|
1719
1774
|
# @return [AttributeIp]
|
|
1720
1775
|
def create_ip_attribute(
|
|
@@ -1723,7 +1778,8 @@ module Appwrite
|
|
|
1723
1778
|
key:,
|
|
1724
1779
|
required:,
|
|
1725
1780
|
default: nil,
|
|
1726
|
-
array: nil
|
|
1781
|
+
array: nil,
|
|
1782
|
+
description: nil
|
|
1727
1783
|
)
|
|
1728
1784
|
if database_id.nil? || database_id == ''
|
|
1729
1785
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1750,6 +1806,7 @@ module Appwrite
|
|
|
1750
1806
|
required: required,
|
|
1751
1807
|
default: default,
|
|
1752
1808
|
array: array,
|
|
1809
|
+
description: description,
|
|
1753
1810
|
}
|
|
1754
1811
|
|
|
1755
1812
|
api_headers = {
|
|
@@ -1780,6 +1837,7 @@ module Appwrite
|
|
|
1780
1837
|
# @param [] required Is attribute required?
|
|
1781
1838
|
# @param [String] default Default value. Cannot be set when attribute is required.
|
|
1782
1839
|
# @param [String] new_key New Attribute Key.
|
|
1840
|
+
# @param [String] description Optional description for the attribute.
|
|
1783
1841
|
#
|
|
1784
1842
|
# @return [AttributeIp]
|
|
1785
1843
|
def update_ip_attribute(
|
|
@@ -1788,7 +1846,8 @@ module Appwrite
|
|
|
1788
1846
|
key:,
|
|
1789
1847
|
required:,
|
|
1790
1848
|
default:,
|
|
1791
|
-
new_key: nil
|
|
1849
|
+
new_key: nil,
|
|
1850
|
+
description: nil
|
|
1792
1851
|
)
|
|
1793
1852
|
if database_id.nil? || database_id == ''
|
|
1794
1853
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1819,6 +1878,7 @@ module Appwrite
|
|
|
1819
1878
|
required: required,
|
|
1820
1879
|
default: default,
|
|
1821
1880
|
newKey: new_key,
|
|
1881
|
+
description: description,
|
|
1822
1882
|
}
|
|
1823
1883
|
|
|
1824
1884
|
api_headers = {
|
|
@@ -1846,6 +1906,7 @@ module Appwrite
|
|
|
1846
1906
|
# @param [String] key Attribute Key.
|
|
1847
1907
|
# @param [] required Is attribute required?
|
|
1848
1908
|
# @param [Array] default Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
|
|
1909
|
+
# @param [String] description Optional description for the attribute.
|
|
1849
1910
|
#
|
|
1850
1911
|
# @return [AttributeLine]
|
|
1851
1912
|
def create_line_attribute(
|
|
@@ -1853,7 +1914,8 @@ module Appwrite
|
|
|
1853
1914
|
collection_id:,
|
|
1854
1915
|
key:,
|
|
1855
1916
|
required:,
|
|
1856
|
-
default: nil
|
|
1917
|
+
default: nil,
|
|
1918
|
+
description: nil
|
|
1857
1919
|
)
|
|
1858
1920
|
if database_id.nil? || database_id == ''
|
|
1859
1921
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1879,6 +1941,7 @@ module Appwrite
|
|
|
1879
1941
|
key: key,
|
|
1880
1942
|
required: required,
|
|
1881
1943
|
default: default,
|
|
1944
|
+
description: description,
|
|
1882
1945
|
}
|
|
1883
1946
|
|
|
1884
1947
|
api_headers = {
|
|
@@ -1908,6 +1971,7 @@ module Appwrite
|
|
|
1908
1971
|
# @param [] required Is attribute required?
|
|
1909
1972
|
# @param [Array] default Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
|
|
1910
1973
|
# @param [String] new_key New attribute key.
|
|
1974
|
+
# @param [String] description Optional description for the attribute.
|
|
1911
1975
|
#
|
|
1912
1976
|
# @return [AttributeLine]
|
|
1913
1977
|
def update_line_attribute(
|
|
@@ -1916,7 +1980,8 @@ module Appwrite
|
|
|
1916
1980
|
key:,
|
|
1917
1981
|
required:,
|
|
1918
1982
|
default: nil,
|
|
1919
|
-
new_key: nil
|
|
1983
|
+
new_key: nil,
|
|
1984
|
+
description: nil
|
|
1920
1985
|
)
|
|
1921
1986
|
if database_id.nil? || database_id == ''
|
|
1922
1987
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1943,6 +2008,7 @@ module Appwrite
|
|
|
1943
2008
|
required: required,
|
|
1944
2009
|
default: default,
|
|
1945
2010
|
newKey: new_key,
|
|
2011
|
+
description: description,
|
|
1946
2012
|
}
|
|
1947
2013
|
|
|
1948
2014
|
api_headers = {
|
|
@@ -1973,6 +2039,7 @@ module Appwrite
|
|
|
1973
2039
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1974
2040
|
# @param [] array Is attribute an array?
|
|
1975
2041
|
# @param [] encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
2042
|
+
# @param [String] description Optional description for the attribute.
|
|
1976
2043
|
#
|
|
1977
2044
|
# @return [AttributeLongtext]
|
|
1978
2045
|
def create_longtext_attribute(
|
|
@@ -1982,7 +2049,8 @@ module Appwrite
|
|
|
1982
2049
|
required:,
|
|
1983
2050
|
default: nil,
|
|
1984
2051
|
array: nil,
|
|
1985
|
-
encrypt: nil
|
|
2052
|
+
encrypt: nil,
|
|
2053
|
+
description: nil
|
|
1986
2054
|
)
|
|
1987
2055
|
if database_id.nil? || database_id == ''
|
|
1988
2056
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2010,6 +2078,7 @@ module Appwrite
|
|
|
2010
2078
|
default: default,
|
|
2011
2079
|
array: array,
|
|
2012
2080
|
encrypt: encrypt,
|
|
2081
|
+
description: description,
|
|
2013
2082
|
}
|
|
2014
2083
|
|
|
2015
2084
|
api_headers = {
|
|
@@ -2040,6 +2109,7 @@ module Appwrite
|
|
|
2040
2109
|
# @param [] required Is attribute required?
|
|
2041
2110
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2042
2111
|
# @param [String] new_key New Attribute Key.
|
|
2112
|
+
# @param [String] description Optional description for the attribute.
|
|
2043
2113
|
#
|
|
2044
2114
|
# @return [AttributeLongtext]
|
|
2045
2115
|
def update_longtext_attribute(
|
|
@@ -2048,7 +2118,8 @@ module Appwrite
|
|
|
2048
2118
|
key:,
|
|
2049
2119
|
required:,
|
|
2050
2120
|
default:,
|
|
2051
|
-
new_key: nil
|
|
2121
|
+
new_key: nil,
|
|
2122
|
+
description: nil
|
|
2052
2123
|
)
|
|
2053
2124
|
if database_id.nil? || database_id == ''
|
|
2054
2125
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2079,6 +2150,7 @@ module Appwrite
|
|
|
2079
2150
|
required: required,
|
|
2080
2151
|
default: default,
|
|
2081
2152
|
newKey: new_key,
|
|
2153
|
+
description: description,
|
|
2082
2154
|
}
|
|
2083
2155
|
|
|
2084
2156
|
api_headers = {
|
|
@@ -2109,6 +2181,7 @@ module Appwrite
|
|
|
2109
2181
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2110
2182
|
# @param [] array Is attribute an array?
|
|
2111
2183
|
# @param [] encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
2184
|
+
# @param [String] description Optional description for the attribute.
|
|
2112
2185
|
#
|
|
2113
2186
|
# @return [AttributeMediumtext]
|
|
2114
2187
|
def create_mediumtext_attribute(
|
|
@@ -2118,7 +2191,8 @@ module Appwrite
|
|
|
2118
2191
|
required:,
|
|
2119
2192
|
default: nil,
|
|
2120
2193
|
array: nil,
|
|
2121
|
-
encrypt: nil
|
|
2194
|
+
encrypt: nil,
|
|
2195
|
+
description: nil
|
|
2122
2196
|
)
|
|
2123
2197
|
if database_id.nil? || database_id == ''
|
|
2124
2198
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2146,6 +2220,7 @@ module Appwrite
|
|
|
2146
2220
|
default: default,
|
|
2147
2221
|
array: array,
|
|
2148
2222
|
encrypt: encrypt,
|
|
2223
|
+
description: description,
|
|
2149
2224
|
}
|
|
2150
2225
|
|
|
2151
2226
|
api_headers = {
|
|
@@ -2176,6 +2251,7 @@ module Appwrite
|
|
|
2176
2251
|
# @param [] required Is attribute required?
|
|
2177
2252
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2178
2253
|
# @param [String] new_key New Attribute Key.
|
|
2254
|
+
# @param [String] description Optional description for the attribute.
|
|
2179
2255
|
#
|
|
2180
2256
|
# @return [AttributeMediumtext]
|
|
2181
2257
|
def update_mediumtext_attribute(
|
|
@@ -2184,7 +2260,8 @@ module Appwrite
|
|
|
2184
2260
|
key:,
|
|
2185
2261
|
required:,
|
|
2186
2262
|
default:,
|
|
2187
|
-
new_key: nil
|
|
2263
|
+
new_key: nil,
|
|
2264
|
+
description: nil
|
|
2188
2265
|
)
|
|
2189
2266
|
if database_id.nil? || database_id == ''
|
|
2190
2267
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2215,6 +2292,7 @@ module Appwrite
|
|
|
2215
2292
|
required: required,
|
|
2216
2293
|
default: default,
|
|
2217
2294
|
newKey: new_key,
|
|
2295
|
+
description: description,
|
|
2218
2296
|
}
|
|
2219
2297
|
|
|
2220
2298
|
api_headers = {
|
|
@@ -2242,6 +2320,7 @@ module Appwrite
|
|
|
2242
2320
|
# @param [String] key Attribute Key.
|
|
2243
2321
|
# @param [] required Is attribute required?
|
|
2244
2322
|
# @param [Array] default Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
|
|
2323
|
+
# @param [String] description Optional description for the attribute.
|
|
2245
2324
|
#
|
|
2246
2325
|
# @return [AttributePoint]
|
|
2247
2326
|
def create_point_attribute(
|
|
@@ -2249,7 +2328,8 @@ module Appwrite
|
|
|
2249
2328
|
collection_id:,
|
|
2250
2329
|
key:,
|
|
2251
2330
|
required:,
|
|
2252
|
-
default: nil
|
|
2331
|
+
default: nil,
|
|
2332
|
+
description: nil
|
|
2253
2333
|
)
|
|
2254
2334
|
if database_id.nil? || database_id == ''
|
|
2255
2335
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2275,6 +2355,7 @@ module Appwrite
|
|
|
2275
2355
|
key: key,
|
|
2276
2356
|
required: required,
|
|
2277
2357
|
default: default,
|
|
2358
|
+
description: description,
|
|
2278
2359
|
}
|
|
2279
2360
|
|
|
2280
2361
|
api_headers = {
|
|
@@ -2304,6 +2385,7 @@ module Appwrite
|
|
|
2304
2385
|
# @param [] required Is attribute required?
|
|
2305
2386
|
# @param [Array] default Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
|
|
2306
2387
|
# @param [String] new_key New attribute key.
|
|
2388
|
+
# @param [String] description Optional description for the attribute.
|
|
2307
2389
|
#
|
|
2308
2390
|
# @return [AttributePoint]
|
|
2309
2391
|
def update_point_attribute(
|
|
@@ -2312,7 +2394,8 @@ module Appwrite
|
|
|
2312
2394
|
key:,
|
|
2313
2395
|
required:,
|
|
2314
2396
|
default: nil,
|
|
2315
|
-
new_key: nil
|
|
2397
|
+
new_key: nil,
|
|
2398
|
+
description: nil
|
|
2316
2399
|
)
|
|
2317
2400
|
if database_id.nil? || database_id == ''
|
|
2318
2401
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2339,6 +2422,7 @@ module Appwrite
|
|
|
2339
2422
|
required: required,
|
|
2340
2423
|
default: default,
|
|
2341
2424
|
newKey: new_key,
|
|
2425
|
+
description: description,
|
|
2342
2426
|
}
|
|
2343
2427
|
|
|
2344
2428
|
api_headers = {
|
|
@@ -2366,6 +2450,7 @@ module Appwrite
|
|
|
2366
2450
|
# @param [String] key Attribute Key.
|
|
2367
2451
|
# @param [] required Is attribute required?
|
|
2368
2452
|
# @param [Array] default Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
|
|
2453
|
+
# @param [String] description Optional description for the attribute.
|
|
2369
2454
|
#
|
|
2370
2455
|
# @return [AttributePolygon]
|
|
2371
2456
|
def create_polygon_attribute(
|
|
@@ -2373,7 +2458,8 @@ module Appwrite
|
|
|
2373
2458
|
collection_id:,
|
|
2374
2459
|
key:,
|
|
2375
2460
|
required:,
|
|
2376
|
-
default: nil
|
|
2461
|
+
default: nil,
|
|
2462
|
+
description: nil
|
|
2377
2463
|
)
|
|
2378
2464
|
if database_id.nil? || database_id == ''
|
|
2379
2465
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2399,6 +2485,7 @@ module Appwrite
|
|
|
2399
2485
|
key: key,
|
|
2400
2486
|
required: required,
|
|
2401
2487
|
default: default,
|
|
2488
|
+
description: description,
|
|
2402
2489
|
}
|
|
2403
2490
|
|
|
2404
2491
|
api_headers = {
|
|
@@ -2428,6 +2515,7 @@ module Appwrite
|
|
|
2428
2515
|
# @param [] required Is attribute required?
|
|
2429
2516
|
# @param [Array] default Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
|
|
2430
2517
|
# @param [String] new_key New attribute key.
|
|
2518
|
+
# @param [String] description Optional description for the attribute.
|
|
2431
2519
|
#
|
|
2432
2520
|
# @return [AttributePolygon]
|
|
2433
2521
|
def update_polygon_attribute(
|
|
@@ -2436,7 +2524,8 @@ module Appwrite
|
|
|
2436
2524
|
key:,
|
|
2437
2525
|
required:,
|
|
2438
2526
|
default: nil,
|
|
2439
|
-
new_key: nil
|
|
2527
|
+
new_key: nil,
|
|
2528
|
+
description: nil
|
|
2440
2529
|
)
|
|
2441
2530
|
if database_id.nil? || database_id == ''
|
|
2442
2531
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2463,6 +2552,7 @@ module Appwrite
|
|
|
2463
2552
|
required: required,
|
|
2464
2553
|
default: default,
|
|
2465
2554
|
newKey: new_key,
|
|
2555
|
+
description: description,
|
|
2466
2556
|
}
|
|
2467
2557
|
|
|
2468
2558
|
api_headers = {
|
|
@@ -2495,6 +2585,7 @@ module Appwrite
|
|
|
2495
2585
|
# @param [String] key Attribute Key.
|
|
2496
2586
|
# @param [String] two_way_key Two Way Attribute Key.
|
|
2497
2587
|
# @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
|
|
2588
|
+
# @param [String] description Optional description for the attribute.
|
|
2498
2589
|
#
|
|
2499
2590
|
# @return [AttributeRelationship]
|
|
2500
2591
|
def create_relationship_attribute(
|
|
@@ -2505,7 +2596,8 @@ module Appwrite
|
|
|
2505
2596
|
two_way: nil,
|
|
2506
2597
|
key: nil,
|
|
2507
2598
|
two_way_key: nil,
|
|
2508
|
-
on_delete: nil
|
|
2599
|
+
on_delete: nil,
|
|
2600
|
+
description: nil
|
|
2509
2601
|
)
|
|
2510
2602
|
if database_id.nil? || database_id == ''
|
|
2511
2603
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2534,6 +2626,7 @@ module Appwrite
|
|
|
2534
2626
|
key: key,
|
|
2535
2627
|
twoWayKey: two_way_key,
|
|
2536
2628
|
onDelete: on_delete,
|
|
2629
|
+
description: description,
|
|
2537
2630
|
}
|
|
2538
2631
|
|
|
2539
2632
|
api_headers = {
|
|
@@ -2563,6 +2656,7 @@ module Appwrite
|
|
|
2563
2656
|
# @param [String] key Attribute Key.
|
|
2564
2657
|
# @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
|
|
2565
2658
|
# @param [String] new_key New Attribute Key.
|
|
2659
|
+
# @param [String] description Optional description for the attribute.
|
|
2566
2660
|
#
|
|
2567
2661
|
# @return [AttributeRelationship]
|
|
2568
2662
|
def update_relationship_attribute(
|
|
@@ -2570,7 +2664,8 @@ module Appwrite
|
|
|
2570
2664
|
collection_id:,
|
|
2571
2665
|
key:,
|
|
2572
2666
|
on_delete: nil,
|
|
2573
|
-
new_key: nil
|
|
2667
|
+
new_key: nil,
|
|
2668
|
+
description: nil
|
|
2574
2669
|
)
|
|
2575
2670
|
if database_id.nil? || database_id == ''
|
|
2576
2671
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2592,6 +2687,7 @@ module Appwrite
|
|
|
2592
2687
|
api_params = {
|
|
2593
2688
|
onDelete: on_delete,
|
|
2594
2689
|
newKey: new_key,
|
|
2690
|
+
description: description,
|
|
2595
2691
|
}
|
|
2596
2692
|
|
|
2597
2693
|
api_headers = {
|
|
@@ -2623,6 +2719,7 @@ module Appwrite
|
|
|
2623
2719
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2624
2720
|
# @param [] array Is attribute an array?
|
|
2625
2721
|
# @param [] encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
2722
|
+
# @param [String] description Optional description for the attribute.
|
|
2626
2723
|
#
|
|
2627
2724
|
# @return [AttributeString]
|
|
2628
2725
|
def create_string_attribute(
|
|
@@ -2633,7 +2730,8 @@ module Appwrite
|
|
|
2633
2730
|
required:,
|
|
2634
2731
|
default: nil,
|
|
2635
2732
|
array: nil,
|
|
2636
|
-
encrypt: nil
|
|
2733
|
+
encrypt: nil,
|
|
2734
|
+
description: nil
|
|
2637
2735
|
)
|
|
2638
2736
|
if database_id.nil? || database_id == ''
|
|
2639
2737
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2666,6 +2764,7 @@ module Appwrite
|
|
|
2666
2764
|
default: default,
|
|
2667
2765
|
array: array,
|
|
2668
2766
|
encrypt: encrypt,
|
|
2767
|
+
description: description,
|
|
2669
2768
|
}
|
|
2670
2769
|
|
|
2671
2770
|
api_headers = {
|
|
@@ -2697,6 +2796,7 @@ module Appwrite
|
|
|
2697
2796
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2698
2797
|
# @param [Integer] size Maximum size of the string attribute.
|
|
2699
2798
|
# @param [String] new_key New Attribute Key.
|
|
2799
|
+
# @param [String] description Optional description for the attribute.
|
|
2700
2800
|
#
|
|
2701
2801
|
# @return [AttributeString]
|
|
2702
2802
|
def update_string_attribute(
|
|
@@ -2706,7 +2806,8 @@ module Appwrite
|
|
|
2706
2806
|
required:,
|
|
2707
2807
|
default:,
|
|
2708
2808
|
size: nil,
|
|
2709
|
-
new_key: nil
|
|
2809
|
+
new_key: nil,
|
|
2810
|
+
description: nil
|
|
2710
2811
|
)
|
|
2711
2812
|
if database_id.nil? || database_id == ''
|
|
2712
2813
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2738,6 +2839,7 @@ module Appwrite
|
|
|
2738
2839
|
default: default,
|
|
2739
2840
|
size: size,
|
|
2740
2841
|
newKey: new_key,
|
|
2842
|
+
description: description,
|
|
2741
2843
|
}
|
|
2742
2844
|
|
|
2743
2845
|
api_headers = {
|
|
@@ -2768,6 +2870,7 @@ module Appwrite
|
|
|
2768
2870
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2769
2871
|
# @param [] array Is attribute an array?
|
|
2770
2872
|
# @param [] encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
2873
|
+
# @param [String] description Optional description for the attribute.
|
|
2771
2874
|
#
|
|
2772
2875
|
# @return [AttributeText]
|
|
2773
2876
|
def create_text_attribute(
|
|
@@ -2777,7 +2880,8 @@ module Appwrite
|
|
|
2777
2880
|
required:,
|
|
2778
2881
|
default: nil,
|
|
2779
2882
|
array: nil,
|
|
2780
|
-
encrypt: nil
|
|
2883
|
+
encrypt: nil,
|
|
2884
|
+
description: nil
|
|
2781
2885
|
)
|
|
2782
2886
|
if database_id.nil? || database_id == ''
|
|
2783
2887
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2805,6 +2909,7 @@ module Appwrite
|
|
|
2805
2909
|
default: default,
|
|
2806
2910
|
array: array,
|
|
2807
2911
|
encrypt: encrypt,
|
|
2912
|
+
description: description,
|
|
2808
2913
|
}
|
|
2809
2914
|
|
|
2810
2915
|
api_headers = {
|
|
@@ -2835,6 +2940,7 @@ module Appwrite
|
|
|
2835
2940
|
# @param [] required Is attribute required?
|
|
2836
2941
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2837
2942
|
# @param [String] new_key New Attribute Key.
|
|
2943
|
+
# @param [String] description Optional description for the attribute.
|
|
2838
2944
|
#
|
|
2839
2945
|
# @return [AttributeText]
|
|
2840
2946
|
def update_text_attribute(
|
|
@@ -2843,7 +2949,8 @@ module Appwrite
|
|
|
2843
2949
|
key:,
|
|
2844
2950
|
required:,
|
|
2845
2951
|
default:,
|
|
2846
|
-
new_key: nil
|
|
2952
|
+
new_key: nil,
|
|
2953
|
+
description: nil
|
|
2847
2954
|
)
|
|
2848
2955
|
if database_id.nil? || database_id == ''
|
|
2849
2956
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2874,6 +2981,7 @@ module Appwrite
|
|
|
2874
2981
|
required: required,
|
|
2875
2982
|
default: default,
|
|
2876
2983
|
newKey: new_key,
|
|
2984
|
+
description: description,
|
|
2877
2985
|
}
|
|
2878
2986
|
|
|
2879
2987
|
api_headers = {
|
|
@@ -2903,6 +3011,7 @@ module Appwrite
|
|
|
2903
3011
|
# @param [] required Is attribute required?
|
|
2904
3012
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2905
3013
|
# @param [] array Is attribute an array?
|
|
3014
|
+
# @param [String] description Optional description for the attribute.
|
|
2906
3015
|
#
|
|
2907
3016
|
# @return [AttributeUrl]
|
|
2908
3017
|
def create_url_attribute(
|
|
@@ -2911,7 +3020,8 @@ module Appwrite
|
|
|
2911
3020
|
key:,
|
|
2912
3021
|
required:,
|
|
2913
3022
|
default: nil,
|
|
2914
|
-
array: nil
|
|
3023
|
+
array: nil,
|
|
3024
|
+
description: nil
|
|
2915
3025
|
)
|
|
2916
3026
|
if database_id.nil? || database_id == ''
|
|
2917
3027
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2938,6 +3048,7 @@ module Appwrite
|
|
|
2938
3048
|
required: required,
|
|
2939
3049
|
default: default,
|
|
2940
3050
|
array: array,
|
|
3051
|
+
description: description,
|
|
2941
3052
|
}
|
|
2942
3053
|
|
|
2943
3054
|
api_headers = {
|
|
@@ -2968,6 +3079,7 @@ module Appwrite
|
|
|
2968
3079
|
# @param [] required Is attribute required?
|
|
2969
3080
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
2970
3081
|
# @param [String] new_key New Attribute Key.
|
|
3082
|
+
# @param [String] description Optional description for the attribute.
|
|
2971
3083
|
#
|
|
2972
3084
|
# @return [AttributeUrl]
|
|
2973
3085
|
def update_url_attribute(
|
|
@@ -2976,7 +3088,8 @@ module Appwrite
|
|
|
2976
3088
|
key:,
|
|
2977
3089
|
required:,
|
|
2978
3090
|
default:,
|
|
2979
|
-
new_key: nil
|
|
3091
|
+
new_key: nil,
|
|
3092
|
+
description: nil
|
|
2980
3093
|
)
|
|
2981
3094
|
if database_id.nil? || database_id == ''
|
|
2982
3095
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3007,6 +3120,7 @@ module Appwrite
|
|
|
3007
3120
|
required: required,
|
|
3008
3121
|
default: default,
|
|
3009
3122
|
newKey: new_key,
|
|
3123
|
+
description: description,
|
|
3010
3124
|
}
|
|
3011
3125
|
|
|
3012
3126
|
api_headers = {
|
|
@@ -3038,6 +3152,7 @@ module Appwrite
|
|
|
3038
3152
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
3039
3153
|
# @param [] array Is attribute an array?
|
|
3040
3154
|
# @param [] encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
3155
|
+
# @param [String] description Optional description for the attribute.
|
|
3041
3156
|
#
|
|
3042
3157
|
# @return [AttributeVarchar]
|
|
3043
3158
|
def create_varchar_attribute(
|
|
@@ -3048,7 +3163,8 @@ module Appwrite
|
|
|
3048
3163
|
required:,
|
|
3049
3164
|
default: nil,
|
|
3050
3165
|
array: nil,
|
|
3051
|
-
encrypt: nil
|
|
3166
|
+
encrypt: nil,
|
|
3167
|
+
description: nil
|
|
3052
3168
|
)
|
|
3053
3169
|
if database_id.nil? || database_id == ''
|
|
3054
3170
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3081,6 +3197,7 @@ module Appwrite
|
|
|
3081
3197
|
default: default,
|
|
3082
3198
|
array: array,
|
|
3083
3199
|
encrypt: encrypt,
|
|
3200
|
+
description: description,
|
|
3084
3201
|
}
|
|
3085
3202
|
|
|
3086
3203
|
api_headers = {
|
|
@@ -3112,6 +3229,7 @@ module Appwrite
|
|
|
3112
3229
|
# @param [String] default Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
3113
3230
|
# @param [Integer] size Maximum size of the varchar attribute.
|
|
3114
3231
|
# @param [String] new_key New Attribute Key.
|
|
3232
|
+
# @param [String] description Optional description for the attribute.
|
|
3115
3233
|
#
|
|
3116
3234
|
# @return [AttributeVarchar]
|
|
3117
3235
|
def update_varchar_attribute(
|
|
@@ -3121,7 +3239,8 @@ module Appwrite
|
|
|
3121
3239
|
required:,
|
|
3122
3240
|
default:,
|
|
3123
3241
|
size: nil,
|
|
3124
|
-
new_key: nil
|
|
3242
|
+
new_key: nil,
|
|
3243
|
+
description: nil
|
|
3125
3244
|
)
|
|
3126
3245
|
if database_id.nil? || database_id == ''
|
|
3127
3246
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3153,6 +3272,7 @@ module Appwrite
|
|
|
3153
3272
|
default: default,
|
|
3154
3273
|
size: size,
|
|
3155
3274
|
newKey: new_key,
|
|
3275
|
+
description: description,
|
|
3156
3276
|
}
|
|
3157
3277
|
|
|
3158
3278
|
api_headers = {
|
|
@@ -3367,12 +3487,21 @@ module Appwrite
|
|
|
3367
3487
|
# Get a list of all the user's documents in a given collection. You can use
|
|
3368
3488
|
# the query params to filter your results.
|
|
3369
3489
|
#
|
|
3490
|
+
# Documents returned by aggregate, groupBy or distinct queries hold only the
|
|
3491
|
+
# attributes they select, group or aggregate, typed as a document types them,
|
|
3492
|
+
# with a joined attribute named by its join alias (`alias.attribute`). The
|
|
3493
|
+
# response omits their `$id`, `$sequence`, `$createdAt`, `$updatedAt`,
|
|
3494
|
+
# `$permissions`, `$databaseId` and `$collectionId` unless they select or
|
|
3495
|
+
# group it, and those of a right or full join document that no document of
|
|
3496
|
+
# this collection matched. SDK document models fill omitted system attributes
|
|
3497
|
+
# with empty values.
|
|
3498
|
+
#
|
|
3370
3499
|
# @param [String] database_id Database ID.
|
|
3371
3500
|
# @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).
|
|
3372
3501
|
# @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.
|
|
3373
3502
|
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
3374
3503
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
3375
|
-
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
|
|
3504
|
+
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Lists with join queries are not cached. Must be between 0 and 86400 (24 hours).
|
|
3376
3505
|
#
|
|
3377
3506
|
# @return [DocumentList]
|
|
3378
3507
|
def list_documents(
|
|
@@ -3699,6 +3828,65 @@ module Appwrite
|
|
|
3699
3828
|
)
|
|
3700
3829
|
end
|
|
3701
3830
|
|
|
3831
|
+
#
|
|
3832
|
+
# @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createQuery` instead.
|
|
3833
|
+
#
|
|
3834
|
+
# Get a list of all the user's documents in a given collection using a POST
|
|
3835
|
+
# request. This behaves identically to the list documents endpoint but
|
|
3836
|
+
# accepts the queries in the request body, allowing much larger `queries`
|
|
3837
|
+
# arrays than can fit in a URL query string.
|
|
3838
|
+
#
|
|
3839
|
+
#
|
|
3840
|
+
# @param [String] database_id Database ID.
|
|
3841
|
+
# @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).
|
|
3842
|
+
# @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.
|
|
3843
|
+
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
3844
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
3845
|
+
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Lists with join queries are not cached. Must be between 0 and 86400 (24 hours).
|
|
3846
|
+
#
|
|
3847
|
+
# @return [DocumentList]
|
|
3848
|
+
def create_query(
|
|
3849
|
+
database_id:,
|
|
3850
|
+
collection_id:,
|
|
3851
|
+
queries: nil,
|
|
3852
|
+
transaction_id: nil,
|
|
3853
|
+
total: nil,
|
|
3854
|
+
ttl: nil
|
|
3855
|
+
)
|
|
3856
|
+
if database_id.nil? || database_id == ''
|
|
3857
|
+
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
3858
|
+
end
|
|
3859
|
+
|
|
3860
|
+
if collection_id.nil? || collection_id == ''
|
|
3861
|
+
raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
|
|
3862
|
+
end
|
|
3863
|
+
|
|
3864
|
+
api_path = '/databases/{databaseId}/collections/{collectionId}/documents/query'
|
|
3865
|
+
.gsub('{databaseId}', database_id)
|
|
3866
|
+
.gsub('{collectionId}', collection_id)
|
|
3867
|
+
|
|
3868
|
+
api_params = {
|
|
3869
|
+
queries: queries,
|
|
3870
|
+
transactionId: transaction_id,
|
|
3871
|
+
total: total,
|
|
3872
|
+
ttl: ttl,
|
|
3873
|
+
}
|
|
3874
|
+
|
|
3875
|
+
api_headers = {
|
|
3876
|
+
"X-Appwrite-Project": @client.get_config('project'),
|
|
3877
|
+
"content-type": 'application/json',
|
|
3878
|
+
"accept": 'application/json',
|
|
3879
|
+
}
|
|
3880
|
+
|
|
3881
|
+
@client.call(
|
|
3882
|
+
method: 'POST',
|
|
3883
|
+
path: api_path,
|
|
3884
|
+
headers: api_headers,
|
|
3885
|
+
params: api_params,
|
|
3886
|
+
response_type: Models::DocumentList
|
|
3887
|
+
)
|
|
3888
|
+
end
|
|
3889
|
+
|
|
3702
3890
|
#
|
|
3703
3891
|
# @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getRow` instead.
|
|
3704
3892
|
#
|
|
@@ -4125,6 +4313,7 @@ module Appwrite
|
|
|
4125
4313
|
# @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
4126
4314
|
# @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
|
|
4127
4315
|
# @param [Array] lengths Length of index. Maximum of 100
|
|
4316
|
+
# @param [String] description Optional description for the index.
|
|
4128
4317
|
#
|
|
4129
4318
|
# @return [Index]
|
|
4130
4319
|
def create_index(
|
|
@@ -4134,7 +4323,8 @@ module Appwrite
|
|
|
4134
4323
|
type:,
|
|
4135
4324
|
attributes:,
|
|
4136
4325
|
orders: nil,
|
|
4137
|
-
lengths: nil
|
|
4326
|
+
lengths: nil,
|
|
4327
|
+
description: nil
|
|
4138
4328
|
)
|
|
4139
4329
|
if database_id.nil? || database_id == ''
|
|
4140
4330
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -4166,6 +4356,7 @@ module Appwrite
|
|
|
4166
4356
|
attributes: attributes,
|
|
4167
4357
|
orders: orders,
|
|
4168
4358
|
lengths: lengths,
|
|
4359
|
+
description: description,
|
|
4169
4360
|
}
|
|
4170
4361
|
|
|
4171
4362
|
api_headers = {
|