appwrite 11.0.0.pre.rc.4 → 11.0.1
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 +7 -17
- data/lib/appwrite/enums/authentication_factor.rb +3 -2
- data/lib/appwrite/enums/flag.rb +2 -2
- data/lib/appwrite/enums/index_type.rb +0 -1
- data/lib/appwrite/enums/name.rb +1 -0
- data/lib/appwrite/enums/password_hash.rb +2 -2
- data/lib/appwrite/enums/runtime.rb +42 -34
- data/lib/appwrite/enums/{encryption.rb → smtp_encryption.rb} +1 -1
- data/lib/appwrite/id.rb +20 -4
- data/lib/appwrite/models/mfa_recovery_codes.rb +27 -0
- data/lib/appwrite/models/mfa_type.rb +0 -5
- data/lib/appwrite/models/session.rb +8 -3
- data/lib/appwrite/models/user.rb +0 -5
- data/lib/appwrite/services/account.rb +219 -90
- data/lib/appwrite/services/databases.rb +16 -10
- data/lib/appwrite/services/health.rb +80 -1
- data/lib/appwrite/services/messaging.rb +42 -35
- data/lib/appwrite/services/users.rb +115 -22
- data/lib/appwrite.rb +3 -3
- metadata +6 -6
- data/lib/appwrite/enums/message_status.rb +0 -9
@@ -46,12 +46,12 @@ module Appwrite
|
|
46
46
|
# @param [Array] cc Array of target IDs to be added as CC.
|
47
47
|
# @param [Array] bcc Array of target IDs to be added as BCC.
|
48
48
|
# @param [Array] attachments Array of compound bucket IDs to file IDs to be attached to the email.
|
49
|
-
# @param [
|
49
|
+
# @param [] draft Is message a draft
|
50
50
|
# @param [] html Is content of type HTML
|
51
51
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
52
52
|
#
|
53
53
|
# @return [Message]
|
54
|
-
def create_email(message_id:, subject:, content:, topics: nil, users: nil, targets: nil, cc: nil, bcc: nil, attachments: nil,
|
54
|
+
def create_email(message_id:, subject:, content:, topics: nil, users: nil, targets: nil, cc: nil, bcc: nil, attachments: nil, draft: nil, html: nil, scheduled_at: nil)
|
55
55
|
api_path = '/messaging/messages/email'
|
56
56
|
|
57
57
|
if message_id.nil?
|
@@ -76,7 +76,7 @@ module Appwrite
|
|
76
76
|
cc: cc,
|
77
77
|
bcc: bcc,
|
78
78
|
attachments: attachments,
|
79
|
-
|
79
|
+
draft: draft,
|
80
80
|
html: html,
|
81
81
|
scheduledAt: scheduled_at,
|
82
82
|
}
|
@@ -104,14 +104,14 @@ module Appwrite
|
|
104
104
|
# @param [Array] targets List of Targets IDs.
|
105
105
|
# @param [String] subject Email Subject.
|
106
106
|
# @param [String] content Email Content.
|
107
|
-
# @param [
|
107
|
+
# @param [] draft Is message a draft
|
108
108
|
# @param [] html Is content of type HTML
|
109
109
|
# @param [Array] cc Array of target IDs to be added as CC.
|
110
110
|
# @param [Array] bcc Array of target IDs to be added as BCC.
|
111
111
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
112
112
|
#
|
113
113
|
# @return [Message]
|
114
|
-
def update_email(message_id:, topics: nil, users: nil, targets: nil, subject: nil, content: nil,
|
114
|
+
def update_email(message_id:, topics: nil, users: nil, targets: nil, subject: nil, content: nil, draft: nil, html: nil, cc: nil, bcc: nil, scheduled_at: nil)
|
115
115
|
api_path = '/messaging/messages/email/{messageId}'
|
116
116
|
.gsub('{messageId}', message_id)
|
117
117
|
|
@@ -125,7 +125,7 @@ module Appwrite
|
|
125
125
|
targets: targets,
|
126
126
|
subject: subject,
|
127
127
|
content: content,
|
128
|
-
|
128
|
+
draft: draft,
|
129
129
|
html: html,
|
130
130
|
cc: cc,
|
131
131
|
bcc: bcc,
|
@@ -162,11 +162,11 @@ module Appwrite
|
|
162
162
|
# @param [String] color Color for push notification. Available only for Android Platform.
|
163
163
|
# @param [String] tag Tag for push notification. Available only for Android Platform.
|
164
164
|
# @param [String] badge Badge for push notification. Available only for IOS Platform.
|
165
|
-
# @param [
|
165
|
+
# @param [] draft Is message a draft
|
166
166
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
167
167
|
#
|
168
168
|
# @return [Message]
|
169
|
-
def create_push(message_id:, title:, body:, topics: nil, users: nil, targets: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil,
|
169
|
+
def create_push(message_id:, title:, body:, topics: nil, users: nil, targets: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil)
|
170
170
|
api_path = '/messaging/messages/push'
|
171
171
|
|
172
172
|
if message_id.nil?
|
@@ -196,7 +196,7 @@ module Appwrite
|
|
196
196
|
color: color,
|
197
197
|
tag: tag,
|
198
198
|
badge: badge,
|
199
|
-
|
199
|
+
draft: draft,
|
200
200
|
scheduledAt: scheduled_at,
|
201
201
|
}
|
202
202
|
|
@@ -231,11 +231,11 @@ module Appwrite
|
|
231
231
|
# @param [String] color Color for push notification. Available only for Android platforms.
|
232
232
|
# @param [String] tag Tag for push notification. Available only for Android platforms.
|
233
233
|
# @param [Integer] badge Badge for push notification. Available only for iOS platforms.
|
234
|
-
# @param [
|
234
|
+
# @param [] draft Is message a draft
|
235
235
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
236
236
|
#
|
237
237
|
# @return [Message]
|
238
|
-
def update_push(message_id:, topics: nil, users: nil, targets: nil, title: nil, body: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil,
|
238
|
+
def update_push(message_id:, topics: nil, users: nil, targets: nil, title: nil, body: nil, data: nil, action: nil, image: nil, icon: nil, sound: nil, color: nil, tag: nil, badge: nil, draft: nil, scheduled_at: nil)
|
239
239
|
api_path = '/messaging/messages/push/{messageId}'
|
240
240
|
.gsub('{messageId}', message_id)
|
241
241
|
|
@@ -257,7 +257,7 @@ module Appwrite
|
|
257
257
|
color: color,
|
258
258
|
tag: tag,
|
259
259
|
badge: badge,
|
260
|
-
|
260
|
+
draft: draft,
|
261
261
|
scheduledAt: scheduled_at,
|
262
262
|
}
|
263
263
|
|
@@ -282,11 +282,11 @@ module Appwrite
|
|
282
282
|
# @param [Array] topics List of Topic IDs.
|
283
283
|
# @param [Array] users List of User IDs.
|
284
284
|
# @param [Array] targets List of Targets IDs.
|
285
|
-
# @param [
|
285
|
+
# @param [] draft Is message a draft
|
286
286
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
287
287
|
#
|
288
288
|
# @return [Message]
|
289
|
-
def create_sms(message_id:, content:, topics: nil, users: nil, targets: nil,
|
289
|
+
def create_sms(message_id:, content:, topics: nil, users: nil, targets: nil, draft: nil, scheduled_at: nil)
|
290
290
|
api_path = '/messaging/messages/sms'
|
291
291
|
|
292
292
|
if message_id.nil?
|
@@ -303,7 +303,7 @@ module Appwrite
|
|
303
303
|
topics: topics,
|
304
304
|
users: users,
|
305
305
|
targets: targets,
|
306
|
-
|
306
|
+
draft: draft,
|
307
307
|
scheduledAt: scheduled_at,
|
308
308
|
}
|
309
309
|
|
@@ -329,11 +329,11 @@ module Appwrite
|
|
329
329
|
# @param [Array] users List of User IDs.
|
330
330
|
# @param [Array] targets List of Targets IDs.
|
331
331
|
# @param [String] content Email Content.
|
332
|
-
# @param [
|
332
|
+
# @param [] draft Is message a draft
|
333
333
|
# @param [String] scheduled_at Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
|
334
334
|
#
|
335
335
|
# @return [Message]
|
336
|
-
def update_sms(message_id:, topics: nil, users: nil, targets: nil, content: nil,
|
336
|
+
def update_sms(message_id:, topics: nil, users: nil, targets: nil, content: nil, draft: nil, scheduled_at: nil)
|
337
337
|
api_path = '/messaging/messages/sms/{messageId}'
|
338
338
|
.gsub('{messageId}', message_id)
|
339
339
|
|
@@ -346,7 +346,7 @@ module Appwrite
|
|
346
346
|
users: users,
|
347
347
|
targets: targets,
|
348
348
|
content: content,
|
349
|
-
|
349
|
+
draft: draft,
|
350
350
|
scheduledAt: scheduled_at,
|
351
351
|
}
|
352
352
|
|
@@ -395,7 +395,8 @@ module Appwrite
|
|
395
395
|
end
|
396
396
|
|
397
397
|
|
398
|
-
#
|
398
|
+
# Delete a message. If the message is not a draft or scheduled, but has been
|
399
|
+
# sent, this will not recall the message.
|
399
400
|
#
|
400
401
|
# @param [String] message_id Message ID.
|
401
402
|
#
|
@@ -524,10 +525,11 @@ module Appwrite
|
|
524
525
|
# @param [String] auth_key_id APNS authentication key ID.
|
525
526
|
# @param [String] team_id APNS team ID.
|
526
527
|
# @param [String] bundle_id APNS bundle ID.
|
528
|
+
# @param [] sandbox Use APNS sandbox environment.
|
527
529
|
# @param [] enabled Set as enabled.
|
528
530
|
#
|
529
531
|
# @return [Provider]
|
530
|
-
def create_apns_provider(provider_id:, name:, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, enabled: nil)
|
532
|
+
def create_apns_provider(provider_id:, name:, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, sandbox: nil, enabled: nil)
|
531
533
|
api_path = '/messaging/providers/apns'
|
532
534
|
|
533
535
|
if provider_id.nil?
|
@@ -545,6 +547,7 @@ module Appwrite
|
|
545
547
|
authKeyId: auth_key_id,
|
546
548
|
teamId: team_id,
|
547
549
|
bundleId: bundle_id,
|
550
|
+
sandbox: sandbox,
|
548
551
|
enabled: enabled,
|
549
552
|
}
|
550
553
|
|
@@ -571,9 +574,10 @@ module Appwrite
|
|
571
574
|
# @param [String] auth_key_id APNS authentication key ID.
|
572
575
|
# @param [String] team_id APNS team ID.
|
573
576
|
# @param [String] bundle_id APNS bundle ID.
|
577
|
+
# @param [] sandbox Use APNS sandbox environment.
|
574
578
|
#
|
575
579
|
# @return [Provider]
|
576
|
-
def update_apns_provider(provider_id:, name: nil, enabled: nil, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil)
|
580
|
+
def update_apns_provider(provider_id:, name: nil, enabled: nil, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, sandbox: nil)
|
577
581
|
api_path = '/messaging/providers/apns/{providerId}'
|
578
582
|
.gsub('{providerId}', provider_id)
|
579
583
|
|
@@ -588,6 +592,7 @@ module Appwrite
|
|
588
592
|
authKeyId: auth_key_id,
|
589
593
|
teamId: team_id,
|
590
594
|
bundleId: bundle_id,
|
595
|
+
sandbox: sandbox,
|
591
596
|
}
|
592
597
|
|
593
598
|
api_headers = {
|
@@ -784,13 +789,13 @@ module Appwrite
|
|
784
789
|
#
|
785
790
|
# @param [String] provider_id Provider 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.
|
786
791
|
# @param [String] name Provider name.
|
787
|
-
# @param [String]
|
788
|
-
# @param [String] sender_id Msg91
|
789
|
-
# @param [String] auth_key Msg91
|
792
|
+
# @param [String] template_id Msg91 template ID
|
793
|
+
# @param [String] sender_id Msg91 sender ID.
|
794
|
+
# @param [String] auth_key Msg91 auth key.
|
790
795
|
# @param [] enabled Set as enabled.
|
791
796
|
#
|
792
797
|
# @return [Provider]
|
793
|
-
def create_msg91_provider(provider_id:, name:,
|
798
|
+
def create_msg91_provider(provider_id:, name:, template_id: nil, sender_id: nil, auth_key: nil, enabled: nil)
|
794
799
|
api_path = '/messaging/providers/msg91'
|
795
800
|
|
796
801
|
if provider_id.nil?
|
@@ -804,7 +809,7 @@ module Appwrite
|
|
804
809
|
api_params = {
|
805
810
|
providerId: provider_id,
|
806
811
|
name: name,
|
807
|
-
|
812
|
+
templateId: template_id,
|
808
813
|
senderId: sender_id,
|
809
814
|
authKey: auth_key,
|
810
815
|
enabled: enabled,
|
@@ -829,12 +834,12 @@ module Appwrite
|
|
829
834
|
# @param [String] provider_id Provider ID.
|
830
835
|
# @param [String] name Provider name.
|
831
836
|
# @param [] enabled Set as enabled.
|
832
|
-
# @param [String]
|
833
|
-
# @param [String]
|
834
|
-
# @param [String]
|
837
|
+
# @param [String] template_id Msg91 template ID.
|
838
|
+
# @param [String] sender_id Msg91 sender ID.
|
839
|
+
# @param [String] auth_key Msg91 auth key.
|
835
840
|
#
|
836
841
|
# @return [Provider]
|
837
|
-
def update_msg91_provider(provider_id:, name: nil, enabled: nil,
|
842
|
+
def update_msg91_provider(provider_id:, name: nil, enabled: nil, template_id: nil, sender_id: nil, auth_key: nil)
|
838
843
|
api_path = '/messaging/providers/msg91/{providerId}'
|
839
844
|
.gsub('{providerId}', provider_id)
|
840
845
|
|
@@ -845,9 +850,9 @@ module Appwrite
|
|
845
850
|
api_params = {
|
846
851
|
name: name,
|
847
852
|
enabled: enabled,
|
853
|
+
templateId: template_id,
|
848
854
|
senderId: sender_id,
|
849
855
|
authKey: auth_key,
|
850
|
-
from: from,
|
851
856
|
}
|
852
857
|
|
853
858
|
api_headers = {
|
@@ -864,7 +869,7 @@ module Appwrite
|
|
864
869
|
end
|
865
870
|
|
866
871
|
|
867
|
-
#
|
872
|
+
# Create a new Sendgrid provider.
|
868
873
|
#
|
869
874
|
# @param [String] provider_id Provider 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.
|
870
875
|
# @param [String] name Provider name.
|
@@ -964,7 +969,7 @@ module Appwrite
|
|
964
969
|
# @param [Integer] port The default SMTP server port.
|
965
970
|
# @param [String] username Authentication username.
|
966
971
|
# @param [String] password Authentication password.
|
967
|
-
# @param [
|
972
|
+
# @param [SmtpEncryption] encryption Encryption type. Can be omitted, 'ssl', or 'tls'
|
968
973
|
# @param [] auto_tls Enable SMTP AutoTLS feature.
|
969
974
|
# @param [String] mailer The value to use for the X-Mailer header.
|
970
975
|
# @param [String] from_name Sender Name.
|
@@ -1028,7 +1033,7 @@ module Appwrite
|
|
1028
1033
|
# @param [Integer] port SMTP port.
|
1029
1034
|
# @param [String] username Authentication username.
|
1030
1035
|
# @param [String] password Authentication password.
|
1031
|
-
# @param [
|
1036
|
+
# @param [SmtpEncryption] encryption Encryption type. Can be 'ssl' or 'tls'
|
1032
1037
|
# @param [] auto_tls Enable SMTP AutoTLS feature.
|
1033
1038
|
# @param [String] mailer The value to use for the X-Mailer header.
|
1034
1039
|
# @param [String] from_name Sender Name.
|
@@ -1638,9 +1643,10 @@ module Appwrite
|
|
1638
1643
|
#
|
1639
1644
|
# @param [String] topic_id Topic ID.
|
1640
1645
|
# @param [String] name Topic Name.
|
1646
|
+
# @param [Array] subscribe An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
1641
1647
|
#
|
1642
1648
|
# @return [Topic]
|
1643
|
-
def update_topic(topic_id:, name: nil)
|
1649
|
+
def update_topic(topic_id:, name: nil, subscribe: nil)
|
1644
1650
|
api_path = '/messaging/topics/{topicId}'
|
1645
1651
|
.gsub('{topicId}', topic_id)
|
1646
1652
|
|
@@ -1650,6 +1656,7 @@ module Appwrite
|
|
1650
1656
|
|
1651
1657
|
api_params = {
|
1652
1658
|
name: name,
|
1659
|
+
subscribe: subscribe,
|
1653
1660
|
}
|
1654
1661
|
|
1655
1662
|
api_headers = {
|
@@ -714,7 +714,7 @@ module Appwrite
|
|
714
714
|
end
|
715
715
|
|
716
716
|
|
717
|
-
#
|
717
|
+
# Enable or disable MFA on a user account.
|
718
718
|
#
|
719
719
|
# @param [String] user_id User ID.
|
720
720
|
# @param [] mfa Enable or disable MFA.
|
@@ -750,12 +750,48 @@ module Appwrite
|
|
750
750
|
end
|
751
751
|
|
752
752
|
|
753
|
-
#
|
753
|
+
# Delete an authenticator app.
|
754
|
+
#
|
755
|
+
# @param [String] user_id User ID.
|
756
|
+
# @param [AuthenticatorType] type Type of authenticator.
|
757
|
+
#
|
758
|
+
# @return [User]
|
759
|
+
def delete_mfa_authenticator(user_id:, type:)
|
760
|
+
api_path = '/users/{userId}/mfa/authenticators/{type}'
|
761
|
+
.gsub('{userId}', user_id)
|
762
|
+
.gsub('{type}', type)
|
763
|
+
|
764
|
+
if user_id.nil?
|
765
|
+
raise Appwrite::Exception.new('Missing required parameter: "userId"')
|
766
|
+
end
|
767
|
+
|
768
|
+
if type.nil?
|
769
|
+
raise Appwrite::Exception.new('Missing required parameter: "type"')
|
770
|
+
end
|
771
|
+
|
772
|
+
api_params = {
|
773
|
+
}
|
774
|
+
|
775
|
+
api_headers = {
|
776
|
+
"content-type": 'application/json',
|
777
|
+
}
|
778
|
+
|
779
|
+
@client.call(
|
780
|
+
method: 'DELETE',
|
781
|
+
path: api_path,
|
782
|
+
headers: api_headers,
|
783
|
+
params: api_params,
|
784
|
+
response_type: Models::User
|
785
|
+
)
|
786
|
+
end
|
787
|
+
|
788
|
+
|
789
|
+
# List the factors available on the account to be used as a MFA challange.
|
754
790
|
#
|
755
791
|
# @param [String] user_id User ID.
|
756
792
|
#
|
757
793
|
# @return [MfaFactors]
|
758
|
-
def
|
794
|
+
def list_mfa_factors(user_id:)
|
759
795
|
api_path = '/users/{userId}/mfa/factors'
|
760
796
|
.gsub('{userId}', user_id)
|
761
797
|
|
@@ -780,32 +816,89 @@ module Appwrite
|
|
780
816
|
end
|
781
817
|
|
782
818
|
|
783
|
-
#
|
819
|
+
# Get recovery codes that can be used as backup for MFA flow by User ID.
|
820
|
+
# Before getting codes, they must be generated using
|
821
|
+
# [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
|
822
|
+
# method.
|
784
823
|
#
|
785
824
|
# @param [String] user_id User ID.
|
786
|
-
# @param [AuthenticatorType] type Type of authenticator.
|
787
|
-
# @param [String] otp Valid verification token.
|
788
825
|
#
|
789
|
-
# @return [
|
790
|
-
def
|
791
|
-
api_path = '/users/{userId}/mfa/
|
826
|
+
# @return [MfaRecoveryCodes]
|
827
|
+
def get_mfa_recovery_codes(user_id:)
|
828
|
+
api_path = '/users/{userId}/mfa/recovery-codes'
|
792
829
|
.gsub('{userId}', user_id)
|
793
|
-
.gsub('{type}', type)
|
794
830
|
|
795
831
|
if user_id.nil?
|
796
832
|
raise Appwrite::Exception.new('Missing required parameter: "userId"')
|
797
833
|
end
|
798
834
|
|
799
|
-
|
800
|
-
|
835
|
+
api_params = {
|
836
|
+
}
|
837
|
+
|
838
|
+
api_headers = {
|
839
|
+
"content-type": 'application/json',
|
840
|
+
}
|
841
|
+
|
842
|
+
@client.call(
|
843
|
+
method: 'GET',
|
844
|
+
path: api_path,
|
845
|
+
headers: api_headers,
|
846
|
+
params: api_params,
|
847
|
+
response_type: Models::MfaRecoveryCodes
|
848
|
+
)
|
849
|
+
end
|
850
|
+
|
851
|
+
|
852
|
+
# Regenerate recovery codes that can be used as backup for MFA flow by User
|
853
|
+
# ID. Before regenerating codes, they must be first generated using
|
854
|
+
# [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
|
855
|
+
# method.
|
856
|
+
#
|
857
|
+
# @param [String] user_id User ID.
|
858
|
+
#
|
859
|
+
# @return [MfaRecoveryCodes]
|
860
|
+
def update_mfa_recovery_codes(user_id:)
|
861
|
+
api_path = '/users/{userId}/mfa/recovery-codes'
|
862
|
+
.gsub('{userId}', user_id)
|
863
|
+
|
864
|
+
if user_id.nil?
|
865
|
+
raise Appwrite::Exception.new('Missing required parameter: "userId"')
|
801
866
|
end
|
802
867
|
|
803
|
-
|
804
|
-
|
868
|
+
api_params = {
|
869
|
+
}
|
870
|
+
|
871
|
+
api_headers = {
|
872
|
+
"content-type": 'application/json',
|
873
|
+
}
|
874
|
+
|
875
|
+
@client.call(
|
876
|
+
method: 'PUT',
|
877
|
+
path: api_path,
|
878
|
+
headers: api_headers,
|
879
|
+
params: api_params,
|
880
|
+
response_type: Models::MfaRecoveryCodes
|
881
|
+
)
|
882
|
+
end
|
883
|
+
|
884
|
+
|
885
|
+
# Generate recovery codes used as backup for MFA flow for User ID. Recovery
|
886
|
+
# codes can be used as a MFA verification type in
|
887
|
+
# [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
|
888
|
+
# method by client SDK.
|
889
|
+
#
|
890
|
+
# @param [String] user_id User ID.
|
891
|
+
#
|
892
|
+
# @return [MfaRecoveryCodes]
|
893
|
+
def create_mfa_recovery_codes(user_id:)
|
894
|
+
api_path = '/users/{userId}/mfa/recovery-codes'
|
895
|
+
.gsub('{userId}', user_id)
|
896
|
+
|
897
|
+
if user_id.nil?
|
898
|
+
raise Appwrite::Exception.new('Missing required parameter: "userId"')
|
805
899
|
end
|
806
900
|
|
807
901
|
api_params = {
|
808
|
-
otp: otp,
|
809
902
|
}
|
810
903
|
|
811
904
|
api_headers = {
|
@@ -813,11 +906,11 @@ module Appwrite
|
|
813
906
|
}
|
814
907
|
|
815
908
|
@client.call(
|
816
|
-
method: '
|
909
|
+
method: 'PATCH',
|
817
910
|
path: api_path,
|
818
911
|
headers: api_headers,
|
819
912
|
params: api_params,
|
820
|
-
response_type: Models::
|
913
|
+
response_type: Models::MfaRecoveryCodes
|
821
914
|
)
|
822
915
|
end
|
823
916
|
|
@@ -1164,7 +1257,7 @@ module Appwrite
|
|
1164
1257
|
end
|
1165
1258
|
|
1166
1259
|
|
1167
|
-
#
|
1260
|
+
# List the messaging targets that are associated with a user.
|
1168
1261
|
#
|
1169
1262
|
# @param [String] user_id User ID.
|
1170
1263
|
# @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
|
@@ -1196,7 +1289,7 @@ module Appwrite
|
|
1196
1289
|
end
|
1197
1290
|
|
1198
1291
|
|
1199
|
-
#
|
1292
|
+
# Create a messaging target.
|
1200
1293
|
#
|
1201
1294
|
# @param [String] user_id User ID.
|
1202
1295
|
# @param [String] target_id Target 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.
|
@@ -1248,7 +1341,7 @@ module Appwrite
|
|
1248
1341
|
end
|
1249
1342
|
|
1250
1343
|
|
1251
|
-
#
|
1344
|
+
# Get a user's push notification target by ID.
|
1252
1345
|
#
|
1253
1346
|
# @param [String] user_id User ID.
|
1254
1347
|
# @param [String] target_id Target ID.
|
@@ -1284,7 +1377,7 @@ module Appwrite
|
|
1284
1377
|
end
|
1285
1378
|
|
1286
1379
|
|
1287
|
-
#
|
1380
|
+
# Update a messaging target.
|
1288
1381
|
#
|
1289
1382
|
# @param [String] user_id User ID.
|
1290
1383
|
# @param [String] target_id Target ID.
|
@@ -1326,7 +1419,7 @@ module Appwrite
|
|
1326
1419
|
end
|
1327
1420
|
|
1328
1421
|
|
1329
|
-
#
|
1422
|
+
# Delete a messaging target.
|
1330
1423
|
#
|
1331
1424
|
# @param [String] user_id User ID.
|
1332
1425
|
# @param [String] target_id Target ID.
|
data/lib/appwrite.rb
CHANGED
@@ -92,6 +92,7 @@ require_relative 'appwrite/models/health_certificate'
|
|
92
92
|
require_relative 'appwrite/models/health_time'
|
93
93
|
require_relative 'appwrite/models/headers'
|
94
94
|
require_relative 'appwrite/models/mfa_challenge'
|
95
|
+
require_relative 'appwrite/models/mfa_recovery_codes'
|
95
96
|
require_relative 'appwrite/models/mfa_type'
|
96
97
|
require_relative 'appwrite/models/mfa_factors'
|
97
98
|
require_relative 'appwrite/models/provider'
|
@@ -100,8 +101,8 @@ require_relative 'appwrite/models/topic'
|
|
100
101
|
require_relative 'appwrite/models/subscriber'
|
101
102
|
require_relative 'appwrite/models/target'
|
102
103
|
|
103
|
-
require_relative 'appwrite/enums/authentication_factor'
|
104
104
|
require_relative 'appwrite/enums/authenticator_type'
|
105
|
+
require_relative 'appwrite/enums/authentication_factor'
|
105
106
|
require_relative 'appwrite/enums/o_auth_provider'
|
106
107
|
require_relative 'appwrite/enums/browser'
|
107
108
|
require_relative 'appwrite/enums/credit_card'
|
@@ -112,8 +113,7 @@ require_relative 'appwrite/enums/index_type'
|
|
112
113
|
require_relative 'appwrite/enums/runtime'
|
113
114
|
require_relative 'appwrite/enums/execution_method'
|
114
115
|
require_relative 'appwrite/enums/name'
|
115
|
-
require_relative 'appwrite/enums/
|
116
|
-
require_relative 'appwrite/enums/encryption'
|
116
|
+
require_relative 'appwrite/enums/smtp_encryption'
|
117
117
|
require_relative 'appwrite/enums/compression'
|
118
118
|
require_relative 'appwrite/enums/image_gravity'
|
119
119
|
require_relative 'appwrite/enums/image_format'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: appwrite
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 11.0.
|
4
|
+
version: 11.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Appwrite Team
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-03-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: mime-types
|
@@ -37,13 +37,11 @@ files:
|
|
37
37
|
- lib/appwrite/enums/browser.rb
|
38
38
|
- lib/appwrite/enums/compression.rb
|
39
39
|
- lib/appwrite/enums/credit_card.rb
|
40
|
-
- lib/appwrite/enums/encryption.rb
|
41
40
|
- lib/appwrite/enums/execution_method.rb
|
42
41
|
- lib/appwrite/enums/flag.rb
|
43
42
|
- lib/appwrite/enums/image_format.rb
|
44
43
|
- lib/appwrite/enums/image_gravity.rb
|
45
44
|
- lib/appwrite/enums/index_type.rb
|
46
|
-
- lib/appwrite/enums/message_status.rb
|
47
45
|
- lib/appwrite/enums/messaging_provider_type.rb
|
48
46
|
- lib/appwrite/enums/name.rb
|
49
47
|
- lib/appwrite/enums/o_auth_provider.rb
|
@@ -51,6 +49,7 @@ files:
|
|
51
49
|
- lib/appwrite/enums/relation_mutate.rb
|
52
50
|
- lib/appwrite/enums/relationship_type.rb
|
53
51
|
- lib/appwrite/enums/runtime.rb
|
52
|
+
- lib/appwrite/enums/smtp_encryption.rb
|
54
53
|
- lib/appwrite/exception.rb
|
55
54
|
- lib/appwrite/id.rb
|
56
55
|
- lib/appwrite/input_file.rb
|
@@ -118,6 +117,7 @@ files:
|
|
118
117
|
- lib/appwrite/models/message_list.rb
|
119
118
|
- lib/appwrite/models/mfa_challenge.rb
|
120
119
|
- lib/appwrite/models/mfa_factors.rb
|
120
|
+
- lib/appwrite/models/mfa_recovery_codes.rb
|
121
121
|
- lib/appwrite/models/mfa_type.rb
|
122
122
|
- lib/appwrite/models/phone.rb
|
123
123
|
- lib/appwrite/models/phone_list.rb
|
@@ -171,9 +171,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
171
171
|
version: '0'
|
172
172
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
173
173
|
requirements:
|
174
|
-
- - "
|
174
|
+
- - ">="
|
175
175
|
- !ruby/object:Gem::Version
|
176
|
-
version:
|
176
|
+
version: '0'
|
177
177
|
requirements: []
|
178
178
|
rubygems_version: 3.1.6
|
179
179
|
signing_key:
|