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.
- checksums.yaml +4 -4
- data/lib/appwrite/client.rb +9 -2
- data/lib/appwrite/enums/build_runtime.rb +2 -0
- data/lib/appwrite/enums/o_auth_provider.rb +1 -0
- data/lib/appwrite/enums/platform_type.rb +11 -0
- data/lib/appwrite/enums/protocol_id.rb +9 -0
- data/lib/appwrite/enums/runtime.rb +2 -0
- data/lib/appwrite/enums/scopes.rb +4 -0
- data/lib/appwrite/enums/service_id.rb +23 -0
- data/lib/appwrite/models/auth_provider.rb +47 -0
- data/lib/appwrite/models/billing_limits.rb +62 -0
- data/lib/appwrite/models/block.rb +47 -0
- data/lib/appwrite/models/dev_key.rb +62 -0
- data/lib/appwrite/models/key.rb +67 -0
- data/lib/appwrite/models/key_list.rb +32 -0
- data/lib/appwrite/models/log.rb +5 -0
- data/lib/appwrite/models/mock_number.rb +32 -0
- data/lib/appwrite/models/platform_android.rb +71 -0
- data/lib/appwrite/models/platform_apple.rb +71 -0
- data/lib/appwrite/models/platform_linux.rb +71 -0
- data/lib/appwrite/models/platform_list.rb +32 -0
- data/lib/appwrite/models/platform_web.rb +71 -0
- data/lib/appwrite/models/platform_windows.rb +71 -0
- data/lib/appwrite/models/project.rb +412 -0
- data/lib/appwrite/models/webhook.rb +20 -20
- data/lib/appwrite/service.rb +1 -1
- data/lib/appwrite/services/account.rb +47 -2
- data/lib/appwrite/services/activities.rb +3 -1
- data/lib/appwrite/services/avatars.rb +9 -1
- data/lib/appwrite/services/backups.rb +13 -1
- data/lib/appwrite/services/databases.rb +132 -6
- data/lib/appwrite/services/functions.rb +27 -1
- data/lib/appwrite/services/graphql.rb +5 -3
- data/lib/appwrite/services/health.rb +26 -1
- data/lib/appwrite/services/locale.rb +9 -1
- data/lib/appwrite/services/messaging.rb +49 -1
- data/lib/appwrite/services/project.rb +840 -1
- data/lib/appwrite/services/sites.rb +26 -1
- data/lib/appwrite/services/storage.rb +14 -1
- data/lib/appwrite/services/tables_db.rb +132 -6
- data/lib/appwrite/services/teams.rb +14 -1
- data/lib/appwrite/services/tokens.rb +6 -1
- data/lib/appwrite/services/users.rb +44 -1
- data/lib/appwrite/services/webhooks.rb +31 -21
- data/lib/appwrite.rb +17 -0
- metadata +19 -2
|
@@ -34,6 +34,7 @@ module Appwrite
|
|
|
34
34
|
params: api_params,
|
|
35
35
|
response_type: Models::TeamList
|
|
36
36
|
)
|
|
37
|
+
|
|
37
38
|
end
|
|
38
39
|
|
|
39
40
|
# Create a new team. The user who creates the team will automatically be
|
|
@@ -73,6 +74,7 @@ module Appwrite
|
|
|
73
74
|
params: api_params,
|
|
74
75
|
response_type: Models::Team
|
|
75
76
|
)
|
|
77
|
+
|
|
76
78
|
end
|
|
77
79
|
|
|
78
80
|
# Get a team by its ID. All team members have read access for this resource.
|
|
@@ -101,6 +103,7 @@ module Appwrite
|
|
|
101
103
|
params: api_params,
|
|
102
104
|
response_type: Models::Team
|
|
103
105
|
)
|
|
106
|
+
|
|
104
107
|
end
|
|
105
108
|
|
|
106
109
|
# Update the team's name by its unique ID.
|
|
@@ -136,6 +139,7 @@ module Appwrite
|
|
|
136
139
|
params: api_params,
|
|
137
140
|
response_type: Models::Team
|
|
138
141
|
)
|
|
142
|
+
|
|
139
143
|
end
|
|
140
144
|
|
|
141
145
|
# Delete a team using its ID. Only team members with the owner role can
|
|
@@ -165,6 +169,7 @@ module Appwrite
|
|
|
165
169
|
headers: api_headers,
|
|
166
170
|
params: api_params,
|
|
167
171
|
)
|
|
172
|
+
|
|
168
173
|
end
|
|
169
174
|
|
|
170
175
|
# Use this endpoint to list a team's members using the team's ID. All team
|
|
@@ -201,6 +206,7 @@ module Appwrite
|
|
|
201
206
|
params: api_params,
|
|
202
207
|
response_type: Models::MembershipList
|
|
203
208
|
)
|
|
209
|
+
|
|
204
210
|
end
|
|
205
211
|
|
|
206
212
|
# Invite a new member to join your team. Provide an ID for existing users, or
|
|
@@ -266,6 +272,7 @@ module Appwrite
|
|
|
266
272
|
params: api_params,
|
|
267
273
|
response_type: Models::Membership
|
|
268
274
|
)
|
|
275
|
+
|
|
269
276
|
end
|
|
270
277
|
|
|
271
278
|
# Get a team member by the membership unique id. All team members have read
|
|
@@ -302,6 +309,7 @@ module Appwrite
|
|
|
302
309
|
params: api_params,
|
|
303
310
|
response_type: Models::Membership
|
|
304
311
|
)
|
|
312
|
+
|
|
305
313
|
end
|
|
306
314
|
|
|
307
315
|
# Modify the roles of a team member. Only team members with the owner role
|
|
@@ -346,6 +354,7 @@ module Appwrite
|
|
|
346
354
|
params: api_params,
|
|
347
355
|
response_type: Models::Membership
|
|
348
356
|
)
|
|
357
|
+
|
|
349
358
|
end
|
|
350
359
|
|
|
351
360
|
# This endpoint allows a user to leave a team or for a team owner to delete
|
|
@@ -382,6 +391,7 @@ module Appwrite
|
|
|
382
391
|
headers: api_headers,
|
|
383
392
|
params: api_params,
|
|
384
393
|
)
|
|
394
|
+
|
|
385
395
|
end
|
|
386
396
|
|
|
387
397
|
# Use this endpoint to allow a user to accept an invitation to join a team
|
|
@@ -435,6 +445,7 @@ module Appwrite
|
|
|
435
445
|
params: api_params,
|
|
436
446
|
response_type: Models::Membership
|
|
437
447
|
)
|
|
448
|
+
|
|
438
449
|
end
|
|
439
450
|
|
|
440
451
|
# Get the team's shared preferences by its unique ID. If a preference doesn't
|
|
@@ -465,6 +476,7 @@ module Appwrite
|
|
|
465
476
|
params: api_params,
|
|
466
477
|
response_type: Models::Preferences
|
|
467
478
|
)
|
|
479
|
+
|
|
468
480
|
end
|
|
469
481
|
|
|
470
482
|
# Update the team's preferences by its unique ID. The object you pass is
|
|
@@ -502,7 +514,8 @@ module Appwrite
|
|
|
502
514
|
params: api_params,
|
|
503
515
|
response_type: Models::Preferences
|
|
504
516
|
)
|
|
517
|
+
|
|
505
518
|
end
|
|
506
519
|
|
|
507
520
|
end
|
|
508
|
-
end
|
|
521
|
+
end
|
|
@@ -44,6 +44,7 @@ module Appwrite
|
|
|
44
44
|
params: api_params,
|
|
45
45
|
response_type: Models::ResourceTokenList
|
|
46
46
|
)
|
|
47
|
+
|
|
47
48
|
end
|
|
48
49
|
|
|
49
50
|
# Create a new token. A token is linked to a file. Token can be passed as a
|
|
@@ -82,6 +83,7 @@ module Appwrite
|
|
|
82
83
|
params: api_params,
|
|
83
84
|
response_type: Models::ResourceToken
|
|
84
85
|
)
|
|
86
|
+
|
|
85
87
|
end
|
|
86
88
|
|
|
87
89
|
# Get a token by its unique ID.
|
|
@@ -110,6 +112,7 @@ module Appwrite
|
|
|
110
112
|
params: api_params,
|
|
111
113
|
response_type: Models::ResourceToken
|
|
112
114
|
)
|
|
115
|
+
|
|
113
116
|
end
|
|
114
117
|
|
|
115
118
|
# Update a token by its unique ID. Use this endpoint to update a token's
|
|
@@ -142,6 +145,7 @@ module Appwrite
|
|
|
142
145
|
params: api_params,
|
|
143
146
|
response_type: Models::ResourceToken
|
|
144
147
|
)
|
|
148
|
+
|
|
145
149
|
end
|
|
146
150
|
|
|
147
151
|
# Delete a token by its unique ID.
|
|
@@ -170,7 +174,8 @@ module Appwrite
|
|
|
170
174
|
headers: api_headers,
|
|
171
175
|
params: api_params,
|
|
172
176
|
)
|
|
177
|
+
|
|
173
178
|
end
|
|
174
179
|
|
|
175
180
|
end
|
|
176
|
-
end
|
|
181
|
+
end
|
|
@@ -34,6 +34,7 @@ module Appwrite
|
|
|
34
34
|
params: api_params,
|
|
35
35
|
response_type: Models::UserList
|
|
36
36
|
)
|
|
37
|
+
|
|
37
38
|
end
|
|
38
39
|
|
|
39
40
|
# Create a new user.
|
|
@@ -71,6 +72,7 @@ module Appwrite
|
|
|
71
72
|
params: api_params,
|
|
72
73
|
response_type: Models::User
|
|
73
74
|
)
|
|
75
|
+
|
|
74
76
|
end
|
|
75
77
|
|
|
76
78
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -117,6 +119,7 @@ module Appwrite
|
|
|
117
119
|
params: api_params,
|
|
118
120
|
response_type: Models::User
|
|
119
121
|
)
|
|
122
|
+
|
|
120
123
|
end
|
|
121
124
|
|
|
122
125
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -163,6 +166,7 @@ module Appwrite
|
|
|
163
166
|
params: api_params,
|
|
164
167
|
response_type: Models::User
|
|
165
168
|
)
|
|
169
|
+
|
|
166
170
|
end
|
|
167
171
|
|
|
168
172
|
# Get identities for all users.
|
|
@@ -191,6 +195,7 @@ module Appwrite
|
|
|
191
195
|
params: api_params,
|
|
192
196
|
response_type: Models::IdentityList
|
|
193
197
|
)
|
|
198
|
+
|
|
194
199
|
end
|
|
195
200
|
|
|
196
201
|
# Delete an identity by its unique ID.
|
|
@@ -219,6 +224,7 @@ module Appwrite
|
|
|
219
224
|
headers: api_headers,
|
|
220
225
|
params: api_params,
|
|
221
226
|
)
|
|
227
|
+
|
|
222
228
|
end
|
|
223
229
|
|
|
224
230
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -265,6 +271,7 @@ module Appwrite
|
|
|
265
271
|
params: api_params,
|
|
266
272
|
response_type: Models::User
|
|
267
273
|
)
|
|
274
|
+
|
|
268
275
|
end
|
|
269
276
|
|
|
270
277
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -311,6 +318,7 @@ module Appwrite
|
|
|
311
318
|
params: api_params,
|
|
312
319
|
response_type: Models::User
|
|
313
320
|
)
|
|
321
|
+
|
|
314
322
|
end
|
|
315
323
|
|
|
316
324
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -387,6 +395,7 @@ module Appwrite
|
|
|
387
395
|
params: api_params,
|
|
388
396
|
response_type: Models::User
|
|
389
397
|
)
|
|
398
|
+
|
|
390
399
|
end
|
|
391
400
|
|
|
392
401
|
# Create a new user. Password provided must be hashed with the [Scrypt
|
|
@@ -452,6 +461,7 @@ module Appwrite
|
|
|
452
461
|
params: api_params,
|
|
453
462
|
response_type: Models::User
|
|
454
463
|
)
|
|
464
|
+
|
|
455
465
|
end
|
|
456
466
|
|
|
457
467
|
# Create a new user. Password provided must be hashed with the
|
|
@@ -500,6 +510,7 @@ module Appwrite
|
|
|
500
510
|
params: api_params,
|
|
501
511
|
response_type: Models::User
|
|
502
512
|
)
|
|
513
|
+
|
|
503
514
|
end
|
|
504
515
|
|
|
505
516
|
# Get a user by its unique ID.
|
|
@@ -528,6 +539,7 @@ module Appwrite
|
|
|
528
539
|
params: api_params,
|
|
529
540
|
response_type: Models::User
|
|
530
541
|
)
|
|
542
|
+
|
|
531
543
|
end
|
|
532
544
|
|
|
533
545
|
# Delete a user by its unique ID, thereby releasing it's ID. Since ID is
|
|
@@ -561,6 +573,7 @@ module Appwrite
|
|
|
561
573
|
headers: api_headers,
|
|
562
574
|
params: api_params,
|
|
563
575
|
)
|
|
576
|
+
|
|
564
577
|
end
|
|
565
578
|
|
|
566
579
|
# Update the user email by its unique ID.
|
|
@@ -596,6 +609,7 @@ module Appwrite
|
|
|
596
609
|
params: api_params,
|
|
597
610
|
response_type: Models::User
|
|
598
611
|
)
|
|
612
|
+
|
|
599
613
|
end
|
|
600
614
|
|
|
601
615
|
# Enable or disable whether a user can impersonate other users. When
|
|
@@ -636,6 +650,7 @@ module Appwrite
|
|
|
636
650
|
params: api_params,
|
|
637
651
|
response_type: Models::User
|
|
638
652
|
)
|
|
653
|
+
|
|
639
654
|
end
|
|
640
655
|
|
|
641
656
|
# Use this endpoint to create a JSON Web Token for user by its unique ID. You
|
|
@@ -671,6 +686,7 @@ module Appwrite
|
|
|
671
686
|
params: api_params,
|
|
672
687
|
response_type: Models::Jwt
|
|
673
688
|
)
|
|
689
|
+
|
|
674
690
|
end
|
|
675
691
|
|
|
676
692
|
# Update the user labels by its unique ID.
|
|
@@ -711,6 +727,7 @@ module Appwrite
|
|
|
711
727
|
params: api_params,
|
|
712
728
|
response_type: Models::User
|
|
713
729
|
)
|
|
730
|
+
|
|
714
731
|
end
|
|
715
732
|
|
|
716
733
|
# Get the user activity logs list by its unique ID.
|
|
@@ -743,6 +760,7 @@ module Appwrite
|
|
|
743
760
|
params: api_params,
|
|
744
761
|
response_type: Models::LogList
|
|
745
762
|
)
|
|
763
|
+
|
|
746
764
|
end
|
|
747
765
|
|
|
748
766
|
# Get the user membership list by its unique ID.
|
|
@@ -777,6 +795,7 @@ module Appwrite
|
|
|
777
795
|
params: api_params,
|
|
778
796
|
response_type: Models::MembershipList
|
|
779
797
|
)
|
|
798
|
+
|
|
780
799
|
end
|
|
781
800
|
|
|
782
801
|
# Enable or disable MFA on a user account.
|
|
@@ -812,6 +831,7 @@ module Appwrite
|
|
|
812
831
|
params: api_params,
|
|
813
832
|
response_type: Models::User
|
|
814
833
|
)
|
|
834
|
+
|
|
815
835
|
end
|
|
816
836
|
|
|
817
837
|
# Delete an authenticator app.
|
|
@@ -846,6 +866,7 @@ module Appwrite
|
|
|
846
866
|
headers: api_headers,
|
|
847
867
|
params: api_params,
|
|
848
868
|
)
|
|
869
|
+
|
|
849
870
|
end
|
|
850
871
|
|
|
851
872
|
# List the factors available on the account to be used as a MFA challange.
|
|
@@ -874,6 +895,7 @@ module Appwrite
|
|
|
874
895
|
params: api_params,
|
|
875
896
|
response_type: Models::MfaFactors
|
|
876
897
|
)
|
|
898
|
+
|
|
877
899
|
end
|
|
878
900
|
|
|
879
901
|
# Get recovery codes that can be used as backup for MFA flow by User ID.
|
|
@@ -905,6 +927,7 @@ module Appwrite
|
|
|
905
927
|
params: api_params,
|
|
906
928
|
response_type: Models::MfaRecoveryCodes
|
|
907
929
|
)
|
|
930
|
+
|
|
908
931
|
end
|
|
909
932
|
|
|
910
933
|
# Regenerate recovery codes that can be used as backup for MFA flow by User
|
|
@@ -937,6 +960,7 @@ module Appwrite
|
|
|
937
960
|
params: api_params,
|
|
938
961
|
response_type: Models::MfaRecoveryCodes
|
|
939
962
|
)
|
|
963
|
+
|
|
940
964
|
end
|
|
941
965
|
|
|
942
966
|
# Generate recovery codes used as backup for MFA flow for User ID. Recovery
|
|
@@ -969,6 +993,7 @@ module Appwrite
|
|
|
969
993
|
params: api_params,
|
|
970
994
|
response_type: Models::MfaRecoveryCodes
|
|
971
995
|
)
|
|
996
|
+
|
|
972
997
|
end
|
|
973
998
|
|
|
974
999
|
# Update the user name by its unique ID.
|
|
@@ -1004,6 +1029,7 @@ module Appwrite
|
|
|
1004
1029
|
params: api_params,
|
|
1005
1030
|
response_type: Models::User
|
|
1006
1031
|
)
|
|
1032
|
+
|
|
1007
1033
|
end
|
|
1008
1034
|
|
|
1009
1035
|
# Update the user password by its unique ID.
|
|
@@ -1039,6 +1065,7 @@ module Appwrite
|
|
|
1039
1065
|
params: api_params,
|
|
1040
1066
|
response_type: Models::User
|
|
1041
1067
|
)
|
|
1068
|
+
|
|
1042
1069
|
end
|
|
1043
1070
|
|
|
1044
1071
|
# Update the user phone by its unique ID.
|
|
@@ -1074,6 +1101,7 @@ module Appwrite
|
|
|
1074
1101
|
params: api_params,
|
|
1075
1102
|
response_type: Models::User
|
|
1076
1103
|
)
|
|
1104
|
+
|
|
1077
1105
|
end
|
|
1078
1106
|
|
|
1079
1107
|
# Get the user preferences by its unique ID.
|
|
@@ -1102,6 +1130,7 @@ module Appwrite
|
|
|
1102
1130
|
params: api_params,
|
|
1103
1131
|
response_type: Models::Preferences
|
|
1104
1132
|
)
|
|
1133
|
+
|
|
1105
1134
|
end
|
|
1106
1135
|
|
|
1107
1136
|
# Update the user preferences by its unique ID. The object you pass is stored
|
|
@@ -1139,6 +1168,7 @@ module Appwrite
|
|
|
1139
1168
|
params: api_params,
|
|
1140
1169
|
response_type: Models::Preferences
|
|
1141
1170
|
)
|
|
1171
|
+
|
|
1142
1172
|
end
|
|
1143
1173
|
|
|
1144
1174
|
# Get the user sessions list by its unique ID.
|
|
@@ -1169,6 +1199,7 @@ module Appwrite
|
|
|
1169
1199
|
params: api_params,
|
|
1170
1200
|
response_type: Models::SessionList
|
|
1171
1201
|
)
|
|
1202
|
+
|
|
1172
1203
|
end
|
|
1173
1204
|
|
|
1174
1205
|
# Creates a session for a user. Returns an immediately usable session object.
|
|
@@ -1203,6 +1234,7 @@ module Appwrite
|
|
|
1203
1234
|
params: api_params,
|
|
1204
1235
|
response_type: Models::Session
|
|
1205
1236
|
)
|
|
1237
|
+
|
|
1206
1238
|
end
|
|
1207
1239
|
|
|
1208
1240
|
# Delete all user's sessions by using the user's unique ID.
|
|
@@ -1231,6 +1263,7 @@ module Appwrite
|
|
|
1231
1263
|
headers: api_headers,
|
|
1232
1264
|
params: api_params,
|
|
1233
1265
|
)
|
|
1266
|
+
|
|
1234
1267
|
end
|
|
1235
1268
|
|
|
1236
1269
|
# Delete a user sessions by its unique ID.
|
|
@@ -1265,6 +1298,7 @@ module Appwrite
|
|
|
1265
1298
|
headers: api_headers,
|
|
1266
1299
|
params: api_params,
|
|
1267
1300
|
)
|
|
1301
|
+
|
|
1268
1302
|
end
|
|
1269
1303
|
|
|
1270
1304
|
# Update the user status by its unique ID. Use this endpoint as an
|
|
@@ -1301,6 +1335,7 @@ module Appwrite
|
|
|
1301
1335
|
params: api_params,
|
|
1302
1336
|
response_type: Models::User
|
|
1303
1337
|
)
|
|
1338
|
+
|
|
1304
1339
|
end
|
|
1305
1340
|
|
|
1306
1341
|
# List the messaging targets that are associated with a user.
|
|
@@ -1333,6 +1368,7 @@ module Appwrite
|
|
|
1333
1368
|
params: api_params,
|
|
1334
1369
|
response_type: Models::TargetList
|
|
1335
1370
|
)
|
|
1371
|
+
|
|
1336
1372
|
end
|
|
1337
1373
|
|
|
1338
1374
|
# Create a messaging target.
|
|
@@ -1384,6 +1420,7 @@ module Appwrite
|
|
|
1384
1420
|
params: api_params,
|
|
1385
1421
|
response_type: Models::Target
|
|
1386
1422
|
)
|
|
1423
|
+
|
|
1387
1424
|
end
|
|
1388
1425
|
|
|
1389
1426
|
# Get a user's push notification target by ID.
|
|
@@ -1418,6 +1455,7 @@ module Appwrite
|
|
|
1418
1455
|
params: api_params,
|
|
1419
1456
|
response_type: Models::Target
|
|
1420
1457
|
)
|
|
1458
|
+
|
|
1421
1459
|
end
|
|
1422
1460
|
|
|
1423
1461
|
# Update a messaging target.
|
|
@@ -1459,6 +1497,7 @@ module Appwrite
|
|
|
1459
1497
|
params: api_params,
|
|
1460
1498
|
response_type: Models::Target
|
|
1461
1499
|
)
|
|
1500
|
+
|
|
1462
1501
|
end
|
|
1463
1502
|
|
|
1464
1503
|
# Delete a messaging target.
|
|
@@ -1493,6 +1532,7 @@ module Appwrite
|
|
|
1493
1532
|
headers: api_headers,
|
|
1494
1533
|
params: api_params,
|
|
1495
1534
|
)
|
|
1535
|
+
|
|
1496
1536
|
end
|
|
1497
1537
|
|
|
1498
1538
|
# Returns a token with a secret key for creating a session. Use the user ID
|
|
@@ -1530,6 +1570,7 @@ module Appwrite
|
|
|
1530
1570
|
params: api_params,
|
|
1531
1571
|
response_type: Models::Token
|
|
1532
1572
|
)
|
|
1573
|
+
|
|
1533
1574
|
end
|
|
1534
1575
|
|
|
1535
1576
|
# Update the user email verification status by its unique ID.
|
|
@@ -1565,6 +1606,7 @@ module Appwrite
|
|
|
1565
1606
|
params: api_params,
|
|
1566
1607
|
response_type: Models::User
|
|
1567
1608
|
)
|
|
1609
|
+
|
|
1568
1610
|
end
|
|
1569
1611
|
|
|
1570
1612
|
# Update the user phone verification status by its unique ID.
|
|
@@ -1600,7 +1642,8 @@ module Appwrite
|
|
|
1600
1642
|
params: api_params,
|
|
1601
1643
|
response_type: Models::User
|
|
1602
1644
|
)
|
|
1645
|
+
|
|
1603
1646
|
end
|
|
1604
1647
|
|
|
1605
1648
|
end
|
|
1606
|
-
end
|
|
1649
|
+
end
|
|
@@ -10,7 +10,7 @@ module Appwrite
|
|
|
10
10
|
# Get a list of all webhooks belonging to the project. You can use the query
|
|
11
11
|
# params to filter your results.
|
|
12
12
|
#
|
|
13
|
-
# @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: name, url,
|
|
13
|
+
# @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: name, url, authUsername, tls, events, enabled, logs, attempts
|
|
14
14
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
15
|
#
|
|
16
16
|
# @return [WebhookList]
|
|
@@ -32,6 +32,7 @@ module Appwrite
|
|
|
32
32
|
params: api_params,
|
|
33
33
|
response_type: Models::WebhookList
|
|
34
34
|
)
|
|
35
|
+
|
|
35
36
|
end
|
|
36
37
|
|
|
37
38
|
# Create a new webhook. Use this endpoint to configure a URL that will
|
|
@@ -42,12 +43,13 @@ module Appwrite
|
|
|
42
43
|
# @param [String] name Webhook name. Max length: 128 chars.
|
|
43
44
|
# @param [Array] events Events list. Maximum of 100 events are allowed.
|
|
44
45
|
# @param [] enabled Enable or disable a webhook.
|
|
45
|
-
# @param []
|
|
46
|
-
# @param [String]
|
|
47
|
-
# @param [String]
|
|
46
|
+
# @param [] tls Certificate verification, false for disabled or true for enabled.
|
|
47
|
+
# @param [String] auth_username Webhook HTTP user. Max length: 256 chars.
|
|
48
|
+
# @param [String] auth_password Webhook HTTP password. Max length: 256 chars.
|
|
49
|
+
# @param [String] secret Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
|
|
48
50
|
#
|
|
49
51
|
# @return [Webhook]
|
|
50
|
-
def create(webhook_id:, url:, name:, events:, enabled: nil,
|
|
52
|
+
def create(webhook_id:, url:, name:, events:, enabled: nil, tls: nil, auth_username: nil, auth_password: nil, secret: nil)
|
|
51
53
|
api_path = '/webhooks'
|
|
52
54
|
|
|
53
55
|
if webhook_id.nil?
|
|
@@ -72,9 +74,10 @@ module Appwrite
|
|
|
72
74
|
name: name,
|
|
73
75
|
events: events,
|
|
74
76
|
enabled: enabled,
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
77
|
+
tls: tls,
|
|
78
|
+
authUsername: auth_username,
|
|
79
|
+
authPassword: auth_password,
|
|
80
|
+
secret: secret,
|
|
78
81
|
}
|
|
79
82
|
|
|
80
83
|
api_headers = {
|
|
@@ -88,6 +91,7 @@ module Appwrite
|
|
|
88
91
|
params: api_params,
|
|
89
92
|
response_type: Models::Webhook
|
|
90
93
|
)
|
|
94
|
+
|
|
91
95
|
end
|
|
92
96
|
|
|
93
97
|
# Get a webhook by its unique ID. This endpoint returns details about a
|
|
@@ -117,6 +121,7 @@ module Appwrite
|
|
|
117
121
|
params: api_params,
|
|
118
122
|
response_type: Models::Webhook
|
|
119
123
|
)
|
|
124
|
+
|
|
120
125
|
end
|
|
121
126
|
|
|
122
127
|
# Update a webhook by its unique ID. Use this endpoint to update the URL,
|
|
@@ -127,12 +132,12 @@ module Appwrite
|
|
|
127
132
|
# @param [String] url Webhook URL.
|
|
128
133
|
# @param [Array] events Events list. Maximum of 100 events are allowed.
|
|
129
134
|
# @param [] enabled Enable or disable a webhook.
|
|
130
|
-
# @param []
|
|
131
|
-
# @param [String]
|
|
132
|
-
# @param [String]
|
|
135
|
+
# @param [] tls Certificate verification, false for disabled or true for enabled.
|
|
136
|
+
# @param [String] auth_username Webhook HTTP user. Max length: 256 chars.
|
|
137
|
+
# @param [String] auth_password Webhook HTTP password. Max length: 256 chars.
|
|
133
138
|
#
|
|
134
139
|
# @return [Webhook]
|
|
135
|
-
def update(webhook_id:, name:, url:, events:, enabled: nil,
|
|
140
|
+
def update(webhook_id:, name:, url:, events:, enabled: nil, tls: nil, auth_username: nil, auth_password: nil)
|
|
136
141
|
api_path = '/webhooks/{webhookId}'
|
|
137
142
|
.gsub('{webhookId}', webhook_id)
|
|
138
143
|
|
|
@@ -157,9 +162,9 @@ module Appwrite
|
|
|
157
162
|
url: url,
|
|
158
163
|
events: events,
|
|
159
164
|
enabled: enabled,
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
165
|
+
tls: tls,
|
|
166
|
+
authUsername: auth_username,
|
|
167
|
+
authPassword: auth_password,
|
|
163
168
|
}
|
|
164
169
|
|
|
165
170
|
api_headers = {
|
|
@@ -173,6 +178,7 @@ module Appwrite
|
|
|
173
178
|
params: api_params,
|
|
174
179
|
response_type: Models::Webhook
|
|
175
180
|
)
|
|
181
|
+
|
|
176
182
|
end
|
|
177
183
|
|
|
178
184
|
# Delete a webhook by its unique ID. Once deleted, the webhook will no longer
|
|
@@ -202,17 +208,19 @@ module Appwrite
|
|
|
202
208
|
headers: api_headers,
|
|
203
209
|
params: api_params,
|
|
204
210
|
)
|
|
211
|
+
|
|
205
212
|
end
|
|
206
213
|
|
|
207
|
-
# Update the webhook
|
|
208
|
-
#
|
|
209
|
-
#
|
|
214
|
+
# Update the webhook signing key. This endpoint can be used to regenerate the
|
|
215
|
+
# signing key used to sign and validate payload deliveries for a specific
|
|
216
|
+
# webhook.
|
|
210
217
|
#
|
|
211
218
|
# @param [String] webhook_id Webhook ID.
|
|
219
|
+
# @param [String] secret Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
|
|
212
220
|
#
|
|
213
221
|
# @return [Webhook]
|
|
214
|
-
def
|
|
215
|
-
api_path = '/webhooks/{webhookId}/
|
|
222
|
+
def update_secret(webhook_id:, secret: nil)
|
|
223
|
+
api_path = '/webhooks/{webhookId}/secret'
|
|
216
224
|
.gsub('{webhookId}', webhook_id)
|
|
217
225
|
|
|
218
226
|
if webhook_id.nil?
|
|
@@ -220,6 +228,7 @@ module Appwrite
|
|
|
220
228
|
end
|
|
221
229
|
|
|
222
230
|
api_params = {
|
|
231
|
+
secret: secret,
|
|
223
232
|
}
|
|
224
233
|
|
|
225
234
|
api_headers = {
|
|
@@ -233,7 +242,8 @@ module Appwrite
|
|
|
233
242
|
params: api_params,
|
|
234
243
|
response_type: Models::Webhook
|
|
235
244
|
)
|
|
245
|
+
|
|
236
246
|
end
|
|
237
247
|
|
|
238
248
|
end
|
|
239
|
-
end
|
|
249
|
+
end
|
data/lib/appwrite.rb
CHANGED
|
@@ -36,6 +36,7 @@ require_relative 'appwrite/models/runtime_list'
|
|
|
36
36
|
require_relative 'appwrite/models/deployment_list'
|
|
37
37
|
require_relative 'appwrite/models/execution_list'
|
|
38
38
|
require_relative 'appwrite/models/webhook_list'
|
|
39
|
+
require_relative 'appwrite/models/key_list'
|
|
39
40
|
require_relative 'appwrite/models/country_list'
|
|
40
41
|
require_relative 'appwrite/models/continent_list'
|
|
41
42
|
require_relative 'appwrite/models/language_list'
|
|
@@ -122,7 +123,18 @@ require_relative 'appwrite/models/framework'
|
|
|
122
123
|
require_relative 'appwrite/models/framework_adapter'
|
|
123
124
|
require_relative 'appwrite/models/deployment'
|
|
124
125
|
require_relative 'appwrite/models/execution'
|
|
126
|
+
require_relative 'appwrite/models/project'
|
|
125
127
|
require_relative 'appwrite/models/webhook'
|
|
128
|
+
require_relative 'appwrite/models/key'
|
|
129
|
+
require_relative 'appwrite/models/dev_key'
|
|
130
|
+
require_relative 'appwrite/models/mock_number'
|
|
131
|
+
require_relative 'appwrite/models/auth_provider'
|
|
132
|
+
require_relative 'appwrite/models/platform_web'
|
|
133
|
+
require_relative 'appwrite/models/platform_apple'
|
|
134
|
+
require_relative 'appwrite/models/platform_android'
|
|
135
|
+
require_relative 'appwrite/models/platform_windows'
|
|
136
|
+
require_relative 'appwrite/models/platform_linux'
|
|
137
|
+
require_relative 'appwrite/models/platform_list'
|
|
126
138
|
require_relative 'appwrite/models/variable'
|
|
127
139
|
require_relative 'appwrite/models/country'
|
|
128
140
|
require_relative 'appwrite/models/continent'
|
|
@@ -148,6 +160,8 @@ require_relative 'appwrite/models/subscriber'
|
|
|
148
160
|
require_relative 'appwrite/models/target'
|
|
149
161
|
require_relative 'appwrite/models/activity_event'
|
|
150
162
|
require_relative 'appwrite/models/backup_archive'
|
|
163
|
+
require_relative 'appwrite/models/billing_limits'
|
|
164
|
+
require_relative 'appwrite/models/block'
|
|
151
165
|
require_relative 'appwrite/models/backup_policy'
|
|
152
166
|
require_relative 'appwrite/models/backup_restoration'
|
|
153
167
|
require_relative 'appwrite/models/activity_event_list'
|
|
@@ -179,6 +193,8 @@ require_relative 'appwrite/enums/execution_method'
|
|
|
179
193
|
require_relative 'appwrite/enums/name'
|
|
180
194
|
require_relative 'appwrite/enums/message_priority'
|
|
181
195
|
require_relative 'appwrite/enums/smtp_encryption'
|
|
196
|
+
require_relative 'appwrite/enums/protocol_id'
|
|
197
|
+
require_relative 'appwrite/enums/service_id'
|
|
182
198
|
require_relative 'appwrite/enums/framework'
|
|
183
199
|
require_relative 'appwrite/enums/build_runtime'
|
|
184
200
|
require_relative 'appwrite/enums/adapter'
|
|
@@ -194,6 +210,7 @@ require_relative 'appwrite/enums/index_status'
|
|
|
194
210
|
require_relative 'appwrite/enums/deployment_status'
|
|
195
211
|
require_relative 'appwrite/enums/execution_trigger'
|
|
196
212
|
require_relative 'appwrite/enums/execution_status'
|
|
213
|
+
require_relative 'appwrite/enums/platform_type'
|
|
197
214
|
require_relative 'appwrite/enums/health_antivirus_status'
|
|
198
215
|
require_relative 'appwrite/enums/health_check_status'
|
|
199
216
|
require_relative 'appwrite/enums/message_status'
|