appwrite 22.0.0 → 23.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/lib/appwrite/client.rb +9 -2
  3. data/lib/appwrite/enums/build_runtime.rb +2 -0
  4. data/lib/appwrite/enums/o_auth_provider.rb +1 -0
  5. data/lib/appwrite/enums/platform_type.rb +11 -0
  6. data/lib/appwrite/enums/protocol_id.rb +9 -0
  7. data/lib/appwrite/enums/runtime.rb +2 -0
  8. data/lib/appwrite/enums/scopes.rb +4 -0
  9. data/lib/appwrite/enums/service_id.rb +23 -0
  10. data/lib/appwrite/models/auth_provider.rb +47 -0
  11. data/lib/appwrite/models/billing_limits.rb +62 -0
  12. data/lib/appwrite/models/block.rb +47 -0
  13. data/lib/appwrite/models/dev_key.rb +62 -0
  14. data/lib/appwrite/models/key.rb +67 -0
  15. data/lib/appwrite/models/key_list.rb +32 -0
  16. data/lib/appwrite/models/log.rb +5 -0
  17. data/lib/appwrite/models/mock_number.rb +32 -0
  18. data/lib/appwrite/models/platform_android.rb +71 -0
  19. data/lib/appwrite/models/platform_apple.rb +71 -0
  20. data/lib/appwrite/models/platform_linux.rb +71 -0
  21. data/lib/appwrite/models/platform_list.rb +32 -0
  22. data/lib/appwrite/models/platform_web.rb +71 -0
  23. data/lib/appwrite/models/platform_windows.rb +71 -0
  24. data/lib/appwrite/models/project.rb +412 -0
  25. data/lib/appwrite/models/webhook.rb +20 -20
  26. data/lib/appwrite/service.rb +1 -1
  27. data/lib/appwrite/services/account.rb +47 -2
  28. data/lib/appwrite/services/activities.rb +3 -1
  29. data/lib/appwrite/services/avatars.rb +9 -1
  30. data/lib/appwrite/services/backups.rb +13 -1
  31. data/lib/appwrite/services/databases.rb +132 -6
  32. data/lib/appwrite/services/functions.rb +27 -1
  33. data/lib/appwrite/services/graphql.rb +5 -3
  34. data/lib/appwrite/services/health.rb +26 -1
  35. data/lib/appwrite/services/locale.rb +9 -1
  36. data/lib/appwrite/services/messaging.rb +49 -1
  37. data/lib/appwrite/services/project.rb +840 -1
  38. data/lib/appwrite/services/sites.rb +26 -1
  39. data/lib/appwrite/services/storage.rb +14 -1
  40. data/lib/appwrite/services/tables_db.rb +132 -6
  41. data/lib/appwrite/services/teams.rb +14 -1
  42. data/lib/appwrite/services/tokens.rb +6 -1
  43. data/lib/appwrite/services/users.rb +44 -1
  44. data/lib/appwrite/services/webhooks.rb +31 -21
  45. data/lib/appwrite.rb +17 -0
  46. metadata +19 -2
@@ -9,10 +9,10 @@ module Appwrite
9
9
  attr_reader :name
10
10
  attr_reader :url
11
11
  attr_reader :events
12
- attr_reader :security
13
- attr_reader :http_user
14
- attr_reader :http_pass
15
- attr_reader :signature_key
12
+ attr_reader :tls
13
+ attr_reader :auth_username
14
+ attr_reader :auth_password
15
+ attr_reader :secret
16
16
  attr_reader :enabled
17
17
  attr_reader :logs
18
18
  attr_reader :attempts
@@ -24,10 +24,10 @@ module Appwrite
24
24
  name:,
25
25
  url:,
26
26
  events:,
27
- security:,
28
- http_user:,
29
- http_pass:,
30
- signature_key:,
27
+ tls:,
28
+ auth_username:,
29
+ auth_password:,
30
+ secret:,
31
31
  enabled:,
32
32
  logs:,
33
33
  attempts:
@@ -38,10 +38,10 @@ module Appwrite
38
38
  @name = name
39
39
  @url = url
40
40
  @events = events
41
- @security = security
42
- @http_user = http_user
43
- @http_pass = http_pass
44
- @signature_key = signature_key
41
+ @tls = tls
42
+ @auth_username = auth_username
43
+ @auth_password = auth_password
44
+ @secret = secret
45
45
  @enabled = enabled
46
46
  @logs = logs
47
47
  @attempts = attempts
@@ -55,10 +55,10 @@ module Appwrite
55
55
  name: map["name"],
56
56
  url: map["url"],
57
57
  events: map["events"],
58
- security: map["security"],
59
- http_user: map["httpUser"],
60
- http_pass: map["httpPass"],
61
- signature_key: map["signatureKey"],
58
+ tls: map["tls"],
59
+ auth_username: map["authUsername"],
60
+ auth_password: map["authPassword"],
61
+ secret: map["secret"],
62
62
  enabled: map["enabled"],
63
63
  logs: map["logs"],
64
64
  attempts: map["attempts"]
@@ -73,10 +73,10 @@ module Appwrite
73
73
  "name": @name,
74
74
  "url": @url,
75
75
  "events": @events,
76
- "security": @security,
77
- "httpUser": @http_user,
78
- "httpPass": @http_pass,
79
- "signatureKey": @signature_key,
76
+ "tls": @tls,
77
+ "authUsername": @auth_username,
78
+ "authPassword": @auth_password,
79
+ "secret": @secret,
80
80
  "enabled": @enabled,
81
81
  "logs": @logs,
82
82
  "attempts": @attempts
@@ -4,4 +4,4 @@ module Appwrite
4
4
  @client = client
5
5
  end
6
6
  end
7
- end
7
+ end
@@ -27,6 +27,7 @@ module Appwrite
27
27
  params: api_params,
28
28
  response_type: Models::User
29
29
  )
30
+
30
31
  end
31
32
 
32
33
  # Use this endpoint to allow a new user to register a new account in your
@@ -76,6 +77,7 @@ module Appwrite
76
77
  params: api_params,
77
78
  response_type: Models::User
78
79
  )
80
+
79
81
  end
80
82
 
81
83
  # Update currently logged in user account email address. After changing user
@@ -118,6 +120,7 @@ module Appwrite
118
120
  params: api_params,
119
121
  response_type: Models::User
120
122
  )
123
+
121
124
  end
122
125
 
123
126
  # Get the list of identities for the currently logged in user.
@@ -144,6 +147,7 @@ module Appwrite
144
147
  params: api_params,
145
148
  response_type: Models::IdentityList
146
149
  )
150
+
147
151
  end
148
152
 
149
153
  # Delete an identity by its unique ID.
@@ -172,6 +176,7 @@ module Appwrite
172
176
  headers: api_headers,
173
177
  params: api_params,
174
178
  )
179
+
175
180
  end
176
181
 
177
182
  # Use this endpoint to create a JSON Web Token. You can use the resulting JWT
@@ -201,6 +206,7 @@ module Appwrite
201
206
  params: api_params,
202
207
  response_type: Models::Jwt
203
208
  )
209
+
204
210
  end
205
211
 
206
212
  # Get the list of latest security activity logs for the currently logged in
@@ -228,6 +234,7 @@ module Appwrite
228
234
  params: api_params,
229
235
  response_type: Models::LogList
230
236
  )
237
+
231
238
  end
232
239
 
233
240
  # Enable or disable MFA on an account.
@@ -257,6 +264,7 @@ module Appwrite
257
264
  params: api_params,
258
265
  response_type: Models::User
259
266
  )
267
+
260
268
  end
261
269
 
262
270
  # Add an authenticator app to be used as an MFA factor. Verify the
@@ -289,6 +297,7 @@ module Appwrite
289
297
  params: api_params,
290
298
  response_type: Models::MfaType
291
299
  )
300
+
292
301
  end
293
302
 
294
303
  # Verify an authenticator app after adding it using the [add
@@ -326,6 +335,7 @@ module Appwrite
326
335
  params: api_params,
327
336
  response_type: Models::User
328
337
  )
338
+
329
339
  end
330
340
 
331
341
  # Delete an authenticator for a user by ID.
@@ -354,6 +364,7 @@ module Appwrite
354
364
  headers: api_headers,
355
365
  params: api_params,
356
366
  )
367
+
357
368
  end
358
369
 
359
370
  # Begin the process of MFA verification after sign-in. Finish the flow with
@@ -385,6 +396,7 @@ module Appwrite
385
396
  params: api_params,
386
397
  response_type: Models::MfaChallenge
387
398
  )
399
+
388
400
  end
389
401
 
390
402
  # Complete the MFA challenge by providing the one-time password. Finish the
@@ -424,6 +436,7 @@ module Appwrite
424
436
  params: api_params,
425
437
  response_type: Models::Session
426
438
  )
439
+
427
440
  end
428
441
 
429
442
  # List the factors available on the account to be used as a MFA challange.
@@ -446,6 +459,7 @@ module Appwrite
446
459
  params: api_params,
447
460
  response_type: Models::MfaFactors
448
461
  )
462
+
449
463
  end
450
464
 
451
465
  # Get recovery codes that can be used as backup for MFA flow. Before getting
@@ -471,6 +485,7 @@ module Appwrite
471
485
  params: api_params,
472
486
  response_type: Models::MfaRecoveryCodes
473
487
  )
488
+
474
489
  end
475
490
 
476
491
  # Generate recovery codes as backup for MFA flow. It's recommended to
@@ -498,6 +513,7 @@ module Appwrite
498
513
  params: api_params,
499
514
  response_type: Models::MfaRecoveryCodes
500
515
  )
516
+
501
517
  end
502
518
 
503
519
  # Regenerate recovery codes that can be used as backup for MFA flow. Before
@@ -524,6 +540,7 @@ module Appwrite
524
540
  params: api_params,
525
541
  response_type: Models::MfaRecoveryCodes
526
542
  )
543
+
527
544
  end
528
545
 
529
546
  # Update currently logged in user account name.
@@ -553,6 +570,7 @@ module Appwrite
553
570
  params: api_params,
554
571
  response_type: Models::User
555
572
  )
573
+
556
574
  end
557
575
 
558
576
  # Update currently logged in user password. For validation, user is required
@@ -586,6 +604,7 @@ module Appwrite
586
604
  params: api_params,
587
605
  response_type: Models::User
588
606
  )
607
+
589
608
  end
590
609
 
591
610
  # Update the currently logged in user's phone number. After updating the
@@ -625,6 +644,7 @@ module Appwrite
625
644
  params: api_params,
626
645
  response_type: Models::User
627
646
  )
647
+
628
648
  end
629
649
 
630
650
  # Get the preferences as a key-value object for the currently logged in user.
@@ -647,6 +667,7 @@ module Appwrite
647
667
  params: api_params,
648
668
  response_type: Models::Preferences
649
669
  )
670
+
650
671
  end
651
672
 
652
673
  # Update currently logged in user account preferences. The object you pass is
@@ -678,6 +699,7 @@ module Appwrite
678
699
  params: api_params,
679
700
  response_type: Models::User
680
701
  )
702
+
681
703
  end
682
704
 
683
705
  # Sends the user an email with a temporary secret key for password reset.
@@ -720,6 +742,7 @@ module Appwrite
720
742
  params: api_params,
721
743
  response_type: Models::Token
722
744
  )
745
+
723
746
  end
724
747
 
725
748
  # Use this endpoint to complete the user account password reset. Both the
@@ -770,6 +793,7 @@ module Appwrite
770
793
  params: api_params,
771
794
  response_type: Models::Token
772
795
  )
796
+
773
797
  end
774
798
 
775
799
  # Get the list of active sessions across different devices for the currently
@@ -793,6 +817,7 @@ module Appwrite
793
817
  params: api_params,
794
818
  response_type: Models::SessionList
795
819
  )
820
+
796
821
  end
797
822
 
798
823
  # Delete all sessions from the user account and remove any sessions cookies
@@ -816,6 +841,7 @@ module Appwrite
816
841
  headers: api_headers,
817
842
  params: api_params,
818
843
  )
844
+
819
845
  end
820
846
 
821
847
  # Use this endpoint to allow a new user to register an anonymous account in
@@ -845,6 +871,7 @@ module Appwrite
845
871
  params: api_params,
846
872
  response_type: Models::Session
847
873
  )
874
+
848
875
  end
849
876
 
850
877
  # Allow the user to login into their account by providing a valid email and
@@ -885,6 +912,7 @@ module Appwrite
885
912
  params: api_params,
886
913
  response_type: Models::Session
887
914
  )
915
+
888
916
  end
889
917
 
890
918
  #
@@ -925,6 +953,7 @@ module Appwrite
925
953
  params: api_params,
926
954
  response_type: Models::Session
927
955
  )
956
+
928
957
  end
929
958
 
930
959
  #
@@ -965,6 +994,7 @@ module Appwrite
965
994
  params: api_params,
966
995
  response_type: Models::Session
967
996
  )
997
+
968
998
  end
969
999
 
970
1000
  # Use this endpoint to create a session from token. Provide the **userId**
@@ -1002,6 +1032,7 @@ module Appwrite
1002
1032
  params: api_params,
1003
1033
  response_type: Models::Session
1004
1034
  )
1035
+
1005
1036
  end
1006
1037
 
1007
1038
  # Use this endpoint to get a logged in user's session using a Session ID.
@@ -1031,6 +1062,7 @@ module Appwrite
1031
1062
  params: api_params,
1032
1063
  response_type: Models::Session
1033
1064
  )
1065
+
1034
1066
  end
1035
1067
 
1036
1068
  # Use this endpoint to extend a session's length. Extending a session is
@@ -1062,6 +1094,7 @@ module Appwrite
1062
1094
  params: api_params,
1063
1095
  response_type: Models::Session
1064
1096
  )
1097
+
1065
1098
  end
1066
1099
 
1067
1100
  # Logout the user. Use 'current' as the session ID to logout on this device,
@@ -1094,6 +1127,7 @@ module Appwrite
1094
1127
  headers: api_headers,
1095
1128
  params: api_params,
1096
1129
  )
1130
+
1097
1131
  end
1098
1132
 
1099
1133
  # Block the currently logged in user account. Behind the scene, the user
@@ -1119,6 +1153,7 @@ module Appwrite
1119
1153
  params: api_params,
1120
1154
  response_type: Models::User
1121
1155
  )
1156
+
1122
1157
  end
1123
1158
 
1124
1159
  # Sends the user an email with a secret key for creating a session. If the
@@ -1169,6 +1204,7 @@ module Appwrite
1169
1204
  params: api_params,
1170
1205
  response_type: Models::Token
1171
1206
  )
1207
+
1172
1208
  end
1173
1209
 
1174
1210
  # Sends the user an email with a secret key for creating a session. If the
@@ -1221,6 +1257,7 @@ module Appwrite
1221
1257
  params: api_params,
1222
1258
  response_type: Models::Token
1223
1259
  )
1260
+
1224
1261
  end
1225
1262
 
1226
1263
  # Allow the user to login to their account using the OAuth2 provider of their
@@ -1238,7 +1275,7 @@ module Appwrite
1238
1275
  # about session
1239
1276
  # limits](https://appwrite.io/docs/authentication-security#limits).
1240
1277
  #
1241
- # @param [OAuthProvider] provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
1278
+ # @param [OAuthProvider] provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
1242
1279
  # @param [String] success URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
1243
1280
  # @param [String] failure URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
1244
1281
  # @param [Array] scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1268,6 +1305,7 @@ module Appwrite
1268
1305
  params: api_params,
1269
1306
  response_type: "location"
1270
1307
  )
1308
+
1271
1309
  end
1272
1310
 
1273
1311
  # Sends the user an SMS with a secret key for creating a session. If the
@@ -1312,6 +1350,7 @@ module Appwrite
1312
1350
  params: api_params,
1313
1351
  response_type: Models::Token
1314
1352
  )
1353
+
1315
1354
  end
1316
1355
 
1317
1356
  # Use this endpoint to send a verification message to your user email address
@@ -1355,6 +1394,7 @@ module Appwrite
1355
1394
  params: api_params,
1356
1395
  response_type: Models::Token
1357
1396
  )
1397
+
1358
1398
  end
1359
1399
 
1360
1400
  #
@@ -1401,6 +1441,7 @@ module Appwrite
1401
1441
  params: api_params,
1402
1442
  response_type: Models::Token
1403
1443
  )
1444
+
1404
1445
  end
1405
1446
 
1406
1447
  # Use this endpoint to complete the user email verification process. Use both
@@ -1439,6 +1480,7 @@ module Appwrite
1439
1480
  params: api_params,
1440
1481
  response_type: Models::Token
1441
1482
  )
1483
+
1442
1484
  end
1443
1485
 
1444
1486
  #
@@ -1480,6 +1522,7 @@ module Appwrite
1480
1522
  params: api_params,
1481
1523
  response_type: Models::Token
1482
1524
  )
1525
+
1483
1526
  end
1484
1527
 
1485
1528
  # Use this endpoint to send a verification SMS to the currently logged in
@@ -1510,6 +1553,7 @@ module Appwrite
1510
1553
  params: api_params,
1511
1554
  response_type: Models::Token
1512
1555
  )
1556
+
1513
1557
  end
1514
1558
 
1515
1559
  # Use this endpoint to complete the user phone verification process. Use the
@@ -1548,7 +1592,8 @@ module Appwrite
1548
1592
  params: api_params,
1549
1593
  response_type: Models::Token
1550
1594
  )
1595
+
1551
1596
  end
1552
1597
 
1553
1598
  end
1554
- end
1599
+ end
@@ -29,6 +29,7 @@ module Appwrite
29
29
  params: api_params,
30
30
  response_type: Models::ActivityEventList
31
31
  )
32
+
32
33
  end
33
34
 
34
35
  # Get event by ID.
@@ -58,7 +59,8 @@ module Appwrite
58
59
  params: api_params,
59
60
  response_type: Models::ActivityEvent
60
61
  )
62
+
61
63
  end
62
64
 
63
65
  end
64
- end
66
+ end
@@ -47,6 +47,7 @@ module Appwrite
47
47
  headers: api_headers,
48
48
  params: api_params,
49
49
  )
50
+
50
51
  end
51
52
 
52
53
  # The credit card endpoint will return you the icon of the credit card
@@ -88,6 +89,7 @@ module Appwrite
88
89
  headers: api_headers,
89
90
  params: api_params,
90
91
  )
92
+
91
93
  end
92
94
 
93
95
  # Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
@@ -118,6 +120,7 @@ module Appwrite
118
120
  headers: api_headers,
119
121
  params: api_params,
120
122
  )
123
+
121
124
  end
122
125
 
123
126
  # You can use this endpoint to show different country flags icons to your
@@ -160,6 +163,7 @@ module Appwrite
160
163
  headers: api_headers,
161
164
  params: api_params,
162
165
  )
166
+
163
167
  end
164
168
 
165
169
  # Use this endpoint to fetch a remote image URL and crop it to any image size
@@ -201,6 +205,7 @@ module Appwrite
201
205
  headers: api_headers,
202
206
  params: api_params,
203
207
  )
208
+
204
209
  end
205
210
 
206
211
  # Use this endpoint to show your user initials avatar icon on your website or
@@ -245,6 +250,7 @@ module Appwrite
245
250
  headers: api_headers,
246
251
  params: api_params,
247
252
  )
253
+
248
254
  end
249
255
 
250
256
  # Converts a given plain text to a QR code image. You can use the query
@@ -280,6 +286,7 @@ module Appwrite
280
286
  headers: api_headers,
281
287
  params: api_params,
282
288
  )
289
+
283
290
  end
284
291
 
285
292
  # Use this endpoint to capture a screenshot of any website URL. This endpoint
@@ -354,7 +361,8 @@ module Appwrite
354
361
  headers: api_headers,
355
362
  params: api_params,
356
363
  )
364
+
357
365
  end
358
366
 
359
367
  end
360
- end
368
+ end
@@ -29,6 +29,7 @@ module Appwrite
29
29
  params: api_params,
30
30
  response_type: Models::BackupArchiveList
31
31
  )
32
+
32
33
  end
33
34
 
34
35
  # Create a new archive asynchronously for a project.
@@ -60,6 +61,7 @@ module Appwrite
60
61
  params: api_params,
61
62
  response_type: Models::BackupArchive
62
63
  )
64
+
63
65
  end
64
66
 
65
67
  # Get a backup archive using it's ID.
@@ -88,6 +90,7 @@ module Appwrite
88
90
  params: api_params,
89
91
  response_type: Models::BackupArchive
90
92
  )
93
+
91
94
  end
92
95
 
93
96
  # Delete an existing archive for a project.
@@ -116,6 +119,7 @@ module Appwrite
116
119
  headers: api_headers,
117
120
  params: api_params,
118
121
  )
122
+
119
123
  end
120
124
 
121
125
  # List all policies for a project.
@@ -140,6 +144,7 @@ module Appwrite
140
144
  params: api_params,
141
145
  response_type: Models::BackupPolicyList
142
146
  )
147
+
143
148
  end
144
149
 
145
150
  # Create a new backup policy.
@@ -193,6 +198,7 @@ module Appwrite
193
198
  params: api_params,
194
199
  response_type: Models::BackupPolicy
195
200
  )
201
+
196
202
  end
197
203
 
198
204
  # Get a backup policy using it's ID.
@@ -221,6 +227,7 @@ module Appwrite
221
227
  params: api_params,
222
228
  response_type: Models::BackupPolicy
223
229
  )
230
+
224
231
  end
225
232
 
226
233
  # Update an existing policy using it's ID.
@@ -258,6 +265,7 @@ module Appwrite
258
265
  params: api_params,
259
266
  response_type: Models::BackupPolicy
260
267
  )
268
+
261
269
  end
262
270
 
263
271
  # Delete a policy using it's ID.
@@ -286,6 +294,7 @@ module Appwrite
286
294
  headers: api_headers,
287
295
  params: api_params,
288
296
  )
297
+
289
298
  end
290
299
 
291
300
  # Create and trigger a new restoration for a backup on a project.
@@ -325,6 +334,7 @@ module Appwrite
325
334
  params: api_params,
326
335
  response_type: Models::BackupRestoration
327
336
  )
337
+
328
338
  end
329
339
 
330
340
  # List all backup restorations for a project.
@@ -349,6 +359,7 @@ module Appwrite
349
359
  params: api_params,
350
360
  response_type: Models::BackupRestorationList
351
361
  )
362
+
352
363
  end
353
364
 
354
365
  # Get the current status of a backup restoration.
@@ -377,7 +388,8 @@ module Appwrite
377
388
  params: api_params,
378
389
  response_type: Models::BackupRestoration
379
390
  )
391
+
380
392
  end
381
393
 
382
394
  end
383
- end
395
+ end