Class: Appwrite::Messaging

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/messaging.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Messaging

Returns a new instance of Messaging.



6
7
8
 
# File 'lib/appwrite/services/messaging.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create_apns_provider(provider_id:, name:, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, sandbox: nil, enabled: nil) ⇒ Provider

Create a new Apple Push Notification service provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • auth_key (String) (defaults to: nil) —

    APNS authentication key.

  • auth_key_id (String) (defaults to: nil) —

    APNS authentication key ID.

  • team_id (String) (defaults to: nil) —

    APNS team ID.

  • bundle_id (String) (defaults to: nil) —

    APNS bundle ID.

  • [] —

    sandbox Use APNS sandbox environment.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/appwrite/services/messaging.rb', line 559

def create_apns_provider(provider_id:, name:, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, sandbox: nil, enabled: nil)
    api_path = '/messaging/providers/apns'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        authKey: auth_key,
        authKeyId: auth_key_id,
        teamId: team_id,
        bundleId: bundle_id,
        sandbox: sandbox,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#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) ⇒ Message

Create a new email message.

Parameters:

  • message_id (String) —

    Message 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.

  • subject (String) —

    Email Subject.

  • content (String) —

    Email Content.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • cc (Array) (defaults to: nil) —

    Array of target IDs to be added as CC.

  • bcc (Array) (defaults to: nil) —

    Array of target IDs to be added as BCC.

  • attachments (Array) (defaults to: nil) —

    Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.

  • [] —

    draft Is message a draft

  • [] —

    html Is content of type HTML

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

Returns:

  • (Message) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/appwrite/services/messaging.rb', line 56

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)
    api_path = '/messaging/messages/email'

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    if subject.nil?
      raise Appwrite::Exception.new('Missing required parameter: "subject"')
    end

    if content.nil?
      raise Appwrite::Exception.new('Missing required parameter: "content"')
    end

    api_params = {
        messageId: message_id,
        subject: subject,
        content: content,
        topics: topics,
        users: users,
        targets: targets,
        cc: cc,
        bcc: bcc,
        attachments: attachments,
        draft: draft,
        html: html,
        scheduledAt: scheduled_at,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#create_fcm_provider(provider_id:, name:, service_account_json: nil, enabled: nil) ⇒ Provider

Create a new Firebase Cloud Messaging provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • service_account_json (Hash) (defaults to: nil) —

    FCM service account JSON.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/appwrite/services/messaging.rb', line 649

def create_fcm_provider(provider_id:, name:, service_account_json: nil, enabled: nil)
    api_path = '/messaging/providers/fcm'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        serviceAccountJSON: ,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_mailgun_provider(provider_id:, name:, api_key: nil, domain: nil, is_eu_region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Create a new Mailgun provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • api_key (String) (defaults to: nil) —

    Mailgun API Key.

  • domain (String) (defaults to: nil) —

    Mailgun Domain.

  • [] —

    is_eu_region Set as EU region.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/appwrite/services/messaging.rb', line 733

def create_mailgun_provider(provider_id:, name:, api_key: nil, domain: nil, is_eu_region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/mailgun'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        apiKey: api_key,
        domain: domain,
        isEuRegion: is_eu_region,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_msg91_provider(provider_id:, name:, template_id: nil, sender_id: nil, auth_key: nil, enabled: nil) ⇒ Provider

Create a new MSG91 provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • template_id (String) (defaults to: nil) —

    Msg91 template ID

  • sender_id (String) (defaults to: nil) —

    Msg91 sender ID.

  • auth_key (String) (defaults to: nil) —

    Msg91 auth key.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/appwrite/services/messaging.rb', line 831

def create_msg91_provider(provider_id:, name:, template_id: nil, sender_id: nil, auth_key: nil, enabled: nil)
    api_path = '/messaging/providers/msg91'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        templateId: template_id,
        senderId: sender_id,
        authKey: auth_key,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_push(message_id:, title: nil, body: nil, 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, content_available: nil, critical: nil, priority: nil) ⇒ Message

Create a new push notification.

Parameters:

  • message_id (String) —

    Message 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.

  • title (String) (defaults to: nil) —

    Title for push notification.

  • body (String) (defaults to: nil) —

    Body for push notification.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • data (Hash) (defaults to: nil) —

    Additional key-value pair data for push notification.

  • action (String) (defaults to: nil) —

    Action for push notification.

  • image (String) (defaults to: nil) —

    Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.

  • icon (String) (defaults to: nil) —

    Icon for push notification. Available only for Android and Web Platform.

  • sound (String) (defaults to: nil) —

    Sound for push notification. Available only for Android and iOS Platform.

  • color (String) (defaults to: nil) —

    Color for push notification. Available only for Android Platform.

  • tag (String) (defaults to: nil) —

    Tag for push notification. Available only for Android Platform.

  • badge (Integer) (defaults to: nil) —

    Badge for push notification. Available only for iOS Platform.

  • [] —

    draft Is message a draft

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

  • [] —

    content_available If set to true, the notification will be delivered in the background. Available only for iOS Platform.

  • [] —

    critical If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.

  • priority (MessagePriority) (defaults to: nil) —

    Set the notification priority. “normal” will consider device state and may not deliver notifications immediately. “high” will always attempt to immediately deliver the notification.

Returns:

  • (Message) 


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/appwrite/services/messaging.rb', line 180

def create_push(message_id:, title: nil, body: nil, 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, content_available: nil, critical: nil, priority: nil)
    api_path = '/messaging/messages/push'

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        messageId: message_id,
        title: title,
        body: body,
        topics: topics,
        users: users,
        targets: targets,
        data: data,
        action: action,
        image: image,
        icon: icon,
        sound: sound,
        color: color,
        tag: tag,
        badge: badge,
        draft: draft,
        scheduledAt: scheduled_at,
        contentAvailable: content_available,
        critical: critical,
        priority: priority,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#create_resend_provider(provider_id:, name:, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Create a new Resend provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • api_key (String) (defaults to: nil) —

    Resend API key.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/appwrite/services/messaging.rb', line 919

def create_resend_provider(provider_id:, name:, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/resend'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        apiKey: api_key,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_sendgrid_provider(provider_id:, name:, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Create a new Sendgrid provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • api_key (String) (defaults to: nil) —

    Sendgrid API key.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/appwrite/services/messaging.rb', line 1013

def create_sendgrid_provider(provider_id:, name:, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/sendgrid'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        apiKey: api_key,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_ses_provider(provider_id:, name:, access_key: nil, secret_key: nil, region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Create a new Amazon SES provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • access_key (String) (defaults to: nil) —

    AWS access key ID.

  • secret_key (String) (defaults to: nil) —

    AWS secret access key.

  • region (String) (defaults to: nil) —

    AWS region, for example us-east-1.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/appwrite/services/messaging.rb', line 1109

def create_ses_provider(provider_id:, name:, access_key: nil, secret_key: nil, region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/ses'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        accessKey: access_key,
        secretKey: secret_key,
        region: region,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_sms(message_id:, content:, topics: nil, users: nil, targets: nil, draft: nil, scheduled_at: nil) ⇒ Message

Create a new SMS message.

Parameters:

  • message_id (String) —

    Message 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.

  • content (String) —

    SMS Content.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • [] —

    draft Is message a draft

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

Returns:

  • (Message) 


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/appwrite/services/messaging.rb', line 305

def create_sms(message_id:, content:, topics: nil, users: nil, targets: nil, draft: nil, scheduled_at: nil)
    api_path = '/messaging/messages/sms'

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    if content.nil?
      raise Appwrite::Exception.new('Missing required parameter: "content"')
    end

    api_params = {
        messageId: message_id,
        content: content,
        topics: topics,
        users: users,
        targets: targets,
        draft: draft,
        scheduledAt: scheduled_at,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#create_smtp_provider(provider_id:, name:, host:, port: nil, username: nil, password: nil, encryption: nil, auto_tls: nil, mailer: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Create a new SMTP provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • host (String) —

    SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as ‘smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465“`. Hosts will be tried in order.

  • port (Integer) (defaults to: nil) —

    The default SMTP server port.

  • username (String) (defaults to: nil) —

    Authentication username.

  • password (String) (defaults to: nil) —

    Authentication password.

  • encryption (SmtpEncryption) (defaults to: nil) —

    Encryption type. Can be omitted, ‘ssl’, or ‘tls’

  • [] —

    auto_tls Enable SMTP AutoTLS feature.

  • mailer (String) (defaults to: nil) —

    The value to use for the X-Mailer header.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/appwrite/services/messaging.rb', line 1215

def create_smtp_provider(provider_id:, name:, host:, port: nil, username: nil, password: nil, encryption: nil, auto_tls: nil, mailer: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/smtp'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    if host.nil?
      raise Appwrite::Exception.new('Missing required parameter: "host"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        host: host,
        port: port,
        username: username,
        password: password,
        encryption: encryption,
        autoTLS: auto_tls,
        mailer: mailer,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_subscriber(topic_id:, subscriber_id:, target_id:) ⇒ Subscriber

Create a new subscriber.

Parameters:

  • topic_id (String) —

    Topic ID. The topic ID to subscribe to.

  • subscriber_id (String) —

    Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.

  • target_id (String) —

    Target ID. The target ID to link to the specified Topic ID.

Returns:

  • (Subscriber) 


2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
 
# File 'lib/appwrite/services/messaging.rb', line 2035

def create_subscriber(topic_id:, subscriber_id:, target_id:)
    api_path = '/messaging/topics/{topicId}/subscribers'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    if subscriber_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "subscriberId"')
    end

    if target_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "targetId"')
    end

    api_params = {
        subscriberId: subscriber_id,
        targetId: target_id,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Subscriber
    )

end

#create_telesign_provider(provider_id:, name:, from: nil, customer_id: nil, api_key: nil, enabled: nil) ⇒ Provider

Create a new Telesign provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • from (String) (defaults to: nil) —

    Sender Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

  • customer_id (String) (defaults to: nil) —

    Telesign customer ID.

  • api_key (String) (defaults to: nil) —

    Telesign API key.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/appwrite/services/messaging.rb', line 1329

def create_telesign_provider(provider_id:, name:, from: nil, customer_id: nil, api_key: nil, enabled: nil)
    api_path = '/messaging/providers/telesign'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        from: from,
        customerId: customer_id,
        apiKey: api_key,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_textmagic_provider(provider_id:, name:, from: nil, username: nil, api_key: nil, enabled: nil) ⇒ Provider

Create a new Textmagic provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • from (String) (defaults to: nil) —

    Sender Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

  • username (String) (defaults to: nil) —

    Textmagic username.

  • api_key (String) (defaults to: nil) —

    Textmagic apiKey.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/appwrite/services/messaging.rb', line 1415

def create_textmagic_provider(provider_id:, name:, from: nil, username: nil, api_key: nil, enabled: nil)
    api_path = '/messaging/providers/textmagic'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        from: from,
        username: username,
        apiKey: api_key,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_topic(topic_id:, name:, subscribe: nil) ⇒ Topic

Create a new topic.

Parameters:

  • topic_id (String) —

    Topic ID. Choose a custom Topic ID or a new Topic ID.

  • name (String) —

    Topic Name.

  • subscribe (Array) (defaults to: nil) —

    An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.

Returns:

  • (Topic) 


1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/appwrite/services/messaging.rb', line 1829

def create_topic(topic_id:, name:, subscribe: nil)
    api_path = '/messaging/topics'

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        topicId: topic_id,
        name: name,
        subscribe: subscribe,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Topic
    )

end

#create_twilio_provider(provider_id:, name:, from: nil, account_sid: nil, auth_token: nil, enabled: nil) ⇒ Provider

Create a new Twilio provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • from (String) (defaults to: nil) —

    Sender Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

  • account_sid (String) (defaults to: nil) —

    Twilio account secret ID.

  • auth_token (String) (defaults to: nil) —

    Twilio authentication token.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/appwrite/services/messaging.rb', line 1501

def create_twilio_provider(provider_id:, name:, from: nil, account_sid: nil, auth_token: nil, enabled: nil)
    api_path = '/messaging/providers/twilio'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        from: from,
        accountSid: ,
        authToken: auth_token,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#create_vonage_provider(provider_id:, name:, from: nil, api_key: nil, api_secret: nil, enabled: nil) ⇒ Provider

Create a new Vonage provider.

Parameters:

  • provider_id (String) —

    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.

  • name (String) —

    Provider name.

  • from (String) (defaults to: nil) —

    Sender Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

  • api_key (String) (defaults to: nil) —

    Vonage API key.

  • api_secret (String) (defaults to: nil) —

    Vonage API secret.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/appwrite/services/messaging.rb', line 1587

def create_vonage_provider(provider_id:, name:, from: nil, api_key: nil, api_secret: nil, enabled: nil)
    api_path = '/messaging/providers/vonage'

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        providerId: provider_id,
        name: name,
        from: from,
        apiKey: api_key,
        apiSecret: api_secret,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#delete(message_id:) ⇒ Object

Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.

Parameters:

  • message_id (String) —

    Message ID.

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/appwrite/services/messaging.rb', line 424

def delete(message_id:)
    api_path = '/messaging/messages/{messageId}'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#delete_provider(provider_id:) ⇒ Object

Delete a provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

Returns:



1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'lib/appwrite/services/messaging.rb', line 1699

def delete_provider(provider_id:)
    api_path = '/messaging/providers/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#delete_subscriber(topic_id:, subscriber_id:) ⇒ Object

Delete a subscriber by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID. The topic ID subscribed to.

  • subscriber_id (String) —

    Subscriber ID.

Returns:



2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/appwrite/services/messaging.rb', line 2114

def delete_subscriber(topic_id:, subscriber_id:)
    api_path = '/messaging/topics/{topicId}/subscribers/{subscriberId}'
        .gsub('{topicId}', topic_id)
        .gsub('{subscriberId}', subscriber_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    if subscriber_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "subscriberId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#delete_topic(topic_id:) ⇒ Object

Delete a topic by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID.

Returns:



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/appwrite/services/messaging.rb', line 1933

def delete_topic(topic_id:)
    api_path = '/messaging/topics/{topicId}'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )

end

#get_message(message_id:) ⇒ Message

Get a message by its unique ID.

Parameters:

  • message_id (String) —

    Message ID.

Returns:

  • (Message) 


393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/appwrite/services/messaging.rb', line 393

def get_message(message_id:)
    api_path = '/messaging/messages/{messageId}'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#get_provider(provider_id:) ⇒ Provider

Get a provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

Returns:

  • (Provider) 


1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/appwrite/services/messaging.rb', line 1669

def get_provider(provider_id:)
    api_path = '/messaging/providers/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#get_subscriber(topic_id:, subscriber_id:) ⇒ Subscriber

Get a subscriber by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID. The topic ID subscribed to.

  • subscriber_id (String) —

    Subscriber ID.

Returns:

  • (Subscriber) 


2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
 
# File 'lib/appwrite/services/messaging.rb', line 2078

def get_subscriber(topic_id:, subscriber_id:)
    api_path = '/messaging/topics/{topicId}/subscribers/{subscriberId}'
        .gsub('{topicId}', topic_id)
        .gsub('{subscriberId}', subscriber_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    if subscriber_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "subscriberId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Subscriber
    )

end

#get_topic(topic_id:) ⇒ Topic

Get a topic by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID.

Returns:

  • (Topic) 


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
 
# File 'lib/appwrite/services/messaging.rb', line 1867

def get_topic(topic_id:)
    api_path = '/messaging/topics/{topicId}'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    api_params = {
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Topic
    )

end

#list_message_logs(message_id:, queries: nil, total: nil) ⇒ LogList

Get the message activity logs listed by its unique ID.

Parameters:

  • message_id (String) —

    Message ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Only supported methods are limit and offset

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (LogList) 


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/appwrite/services/messaging.rb', line 456

def list_message_logs(message_id:, queries: nil, total: nil)
    api_path = '/messaging/messages/{messageId}/logs'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::LogList
    )

end

#list_messages(queries: nil, search: nil, total: nil) ⇒ MessageList

Get a list of all messages from the current Appwrite project.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (MessageList) 


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/appwrite/services/messaging.rb', line 17

def list_messages(queries: nil, search: nil, total: nil)
    api_path = '/messaging/messages'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MessageList
    )

end

#list_provider_logs(provider_id:, queries: nil, total: nil) ⇒ LogList

Get the provider activity logs listed by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Only supported methods are limit and offset

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (LogList) 


1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/appwrite/services/messaging.rb', line 1731

def list_provider_logs(provider_id:, queries: nil, total: nil)
    api_path = '/messaging/providers/{providerId}/logs'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::LogList
    )

end

#list_providers(queries: nil, search: nil, total: nil) ⇒ ProviderList

Get a list of all providers from the current Appwrite project.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (ProviderList) 


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/appwrite/services/messaging.rb', line 524

def list_providers(queries: nil, search: nil, total: nil)
    api_path = '/messaging/providers'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::ProviderList
    )

end

#list_subscriber_logs(subscriber_id:, queries: nil, total: nil) ⇒ LogList

Get the subscriber activity logs listed by its unique ID.

Parameters:

  • subscriber_id (String) —

    Subscriber ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Only supported methods are limit and offset

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (LogList) 


1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/appwrite/services/messaging.rb', line 1765

def list_subscriber_logs(subscriber_id:, queries: nil, total: nil)
    api_path = '/messaging/subscribers/{subscriberId}/logs'
        .gsub('{subscriberId}', subscriber_id)

    if subscriber_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "subscriberId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::LogList
    )

end

#list_subscribers(topic_id:, queries: nil, search: nil, total: nil) ⇒ SubscriberList

Get a list of all subscribers from the current Appwrite project.

Parameters:

  • topic_id (String) —

    Topic ID. The topic ID subscribed to.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: targetId, topicId, userId, providerType

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (SubscriberList) 


2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 
# File 'lib/appwrite/services/messaging.rb', line 2000

def list_subscribers(topic_id:, queries: nil, search: nil, total: nil)
    api_path = '/messaging/topics/{topicId}/subscribers'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::SubscriberList
    )

end

#list_targets(message_id:, queries: nil, total: nil) ⇒ TargetList

Get a list of the targets associated with a message.

Parameters:

  • message_id (String) —

    Message ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (TargetList) 


490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/appwrite/services/messaging.rb', line 490

def list_targets(message_id:, queries: nil, total: nil)
    api_path = '/messaging/messages/{messageId}/targets'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::TargetList
    )

end

#list_topic_logs(topic_id:, queries: nil, total: nil) ⇒ LogList

Get the topic activity logs listed by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Only supported methods are limit and offset

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (LogList) 


1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/appwrite/services/messaging.rb', line 1965

def list_topic_logs(topic_id:, queries: nil, total: nil)
    api_path = '/messaging/topics/{topicId}/logs'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::LogList
    )

end

#list_topics(queries: nil, search: nil, total: nil) ⇒ TopicList

Get a list of all topics from the current Appwrite project.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, description, emailTotal, smsTotal, pushTotal

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (TopicList) 


1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
 
# File 'lib/appwrite/services/messaging.rb', line 1799

def list_topics(queries: nil, search: nil, total: nil)
    api_path = '/messaging/topics'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::TopicList
    )

end

#update_apns_provider(provider_id:, name: nil, enabled: nil, auth_key: nil, auth_key_id: nil, team_id: nil, bundle_id: nil, sandbox: nil) ⇒ Provider

Update a Apple Push Notification service provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • auth_key (String) (defaults to: nil) —

    APNS authentication key.

  • auth_key_id (String) (defaults to: nil) —

    APNS authentication key ID.

  • team_id (String) (defaults to: nil) —

    APNS team ID.

  • bundle_id (String) (defaults to: nil) —

    APNS bundle ID.

  • [] —

    sandbox Use APNS sandbox environment.

Returns:

  • (Provider) 


608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/appwrite/services/messaging.rb', line 608

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)
    api_path = '/messaging/providers/apns/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        authKey: auth_key,
        authKeyId: auth_key_id,
        teamId: team_id,
        bundleId: bundle_id,
        sandbox: sandbox,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#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, attachments: nil) ⇒ Message

Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.

Parameters:

  • message_id (String) —

    Message ID.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • subject (String) (defaults to: nil) —

    Email Subject.

  • content (String) (defaults to: nil) —

    Email Content.

  • [] —

    draft Is message a draft

  • [] —

    html Is content of type HTML

  • cc (Array) (defaults to: nil) —

    Array of target IDs to be added as CC.

  • bcc (Array) (defaults to: nil) —

    Array of target IDs to be added as BCC.

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

  • attachments (Array) (defaults to: nil) —

    Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.

Returns:

  • (Message) 


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/appwrite/services/messaging.rb', line 120

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, attachments: nil)
    api_path = '/messaging/messages/email/{messageId}'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        topics: topics,
        users: users,
        targets: targets,
        subject: subject,
        content: content,
        draft: draft,
        html: html,
        cc: cc,
        bcc: bcc,
        scheduledAt: scheduled_at,
        attachments: attachments,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#update_fcm_provider(provider_id:, name: nil, enabled: nil, service_account_json: nil) ⇒ Provider

Update a Firebase Cloud Messaging provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • service_account_json (Hash) (defaults to: nil) —

    FCM service account JSON.

Returns:

  • (Provider) 


690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'lib/appwrite/services/messaging.rb', line 690

def update_fcm_provider(provider_id:, name: nil, enabled: nil, service_account_json: nil)
    api_path = '/messaging/providers/fcm/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        serviceAccountJSON: ,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_mailgun_provider(provider_id:, name: nil, api_key: nil, domain: nil, is_eu_region: nil, enabled: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil) ⇒ Provider

Update a Mailgun provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • api_key (String) (defaults to: nil) —

    Mailgun API Key.

  • domain (String) (defaults to: nil) —

    Mailgun Domain.

  • [] —

    is_eu_region Set as EU region.

  • [] —

    enabled Set as enabled.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the reply to field for the mail. Default value is sender name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the reply to field for the mail. Default value is sender email.

Returns:

  • (Provider) 


786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/appwrite/services/messaging.rb', line 786

def update_mailgun_provider(provider_id:, name: nil, api_key: nil, domain: nil, is_eu_region: nil, enabled: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil)
    api_path = '/messaging/providers/mailgun/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        apiKey: api_key,
        domain: domain,
        isEuRegion: is_eu_region,
        enabled: enabled,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_msg91_provider(provider_id:, name: nil, enabled: nil, template_id: nil, sender_id: nil, auth_key: nil) ⇒ Provider

Update a MSG91 provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • template_id (String) (defaults to: nil) —

    Msg91 template ID.

  • sender_id (String) (defaults to: nil) —

    Msg91 sender ID.

  • auth_key (String) (defaults to: nil) —

    Msg91 auth key.

Returns:

  • (Provider) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
 
# File 'lib/appwrite/services/messaging.rb', line 876

def update_msg91_provider(provider_id:, name: nil, enabled: nil, template_id: nil, sender_id: nil, auth_key: nil)
    api_path = '/messaging/providers/msg91/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        templateId: template_id,
        senderId: sender_id,
        authKey: auth_key,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#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, content_available: nil, critical: nil, priority: nil) ⇒ Message

Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.

Parameters:

  • message_id (String) —

    Message ID.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • title (String) (defaults to: nil) —

    Title for push notification.

  • body (String) (defaults to: nil) —

    Body for push notification.

  • data (Hash) (defaults to: nil) —

    Additional Data for push notification.

  • action (String) (defaults to: nil) —

    Action for push notification.

  • image (String) (defaults to: nil) —

    Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.

  • icon (String) (defaults to: nil) —

    Icon for push notification. Available only for Android and Web platforms.

  • sound (String) (defaults to: nil) —

    Sound for push notification. Available only for Android and iOS platforms.

  • color (String) (defaults to: nil) —

    Color for push notification. Available only for Android platforms.

  • tag (String) (defaults to: nil) —

    Tag for push notification. Available only for Android platforms.

  • badge (Integer) (defaults to: nil) —

    Badge for push notification. Available only for iOS platforms.

  • [] —

    draft Is message a draft

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

  • [] —

    content_available If set to true, the notification will be delivered in the background. Available only for iOS Platform.

  • [] —

    critical If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.

  • priority (MessagePriority) (defaults to: nil) —

    Set the notification priority. “normal” will consider device battery state and may send notifications later. “high” will always attempt to immediately deliver the notification.

Returns:

  • (Message) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/appwrite/services/messaging.rb', line 250

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, content_available: nil, critical: nil, priority: nil)
    api_path = '/messaging/messages/push/{messageId}'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        topics: topics,
        users: users,
        targets: targets,
        title: title,
        body: body,
        data: data,
        action: action,
        image: image,
        icon: icon,
        sound: sound,
        color: color,
        tag: tag,
        badge: badge,
        draft: draft,
        scheduledAt: scheduled_at,
        contentAvailable: content_available,
        critical: critical,
        priority: priority,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#update_resend_provider(provider_id:, name: nil, enabled: nil, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil) ⇒ Provider

Update a Resend provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • api_key (String) (defaults to: nil) —

    Resend API key.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the Reply To field for the mail. Default value is Sender Name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the Reply To field for the mail. Default value is Sender Email.

Returns:

  • (Provider) 


968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
 
# File 'lib/appwrite/services/messaging.rb', line 968

def update_resend_provider(provider_id:, name: nil, enabled: nil, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil)
    api_path = '/messaging/providers/resend/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        apiKey: api_key,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_sendgrid_provider(provider_id:, name: nil, enabled: nil, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil) ⇒ Provider

Update a Sendgrid provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • api_key (String) (defaults to: nil) —

    Sendgrid API key.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the Reply To field for the mail. Default value is Sender Name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the Reply To field for the mail. Default value is Sender Email.

Returns:

  • (Provider) 


1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/appwrite/services/messaging.rb', line 1062

def update_sendgrid_provider(provider_id:, name: nil, enabled: nil, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil)
    api_path = '/messaging/providers/sendgrid/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        apiKey: api_key,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_ses_provider(provider_id:, name: nil, enabled: nil, access_key: nil, secret_key: nil, region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil) ⇒ Provider

Update an Amazon SES provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • access_key (String) (defaults to: nil) —

    AWS access key ID.

  • secret_key (String) (defaults to: nil) —

    AWS secret access key.

  • region (String) (defaults to: nil) —

    AWS region, for example us-east-1.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the Reply To field for the mail. Default value is Sender Name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the Reply To field for the mail. Default value is Sender Email.

Returns:

  • (Provider) 


1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/appwrite/services/messaging.rb', line 1162

def update_ses_provider(provider_id:, name: nil, enabled: nil, access_key: nil, secret_key: nil, region: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil)
    api_path = '/messaging/providers/ses/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        accessKey: access_key,
        secretKey: secret_key,
        region: region,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_sms(message_id:, topics: nil, users: nil, targets: nil, content: nil, draft: nil, scheduled_at: nil) ⇒ Message

Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.

Parameters:

  • message_id (String) —

    Message ID.

  • topics (Array) (defaults to: nil) —

    List of Topic IDs.

  • users (Array) (defaults to: nil) —

    List of User IDs.

  • targets (Array) (defaults to: nil) —

    List of Targets IDs.

  • content (String) (defaults to: nil) —

    Email Content.

  • [] —

    draft Is message a draft

  • scheduled_at (String) (defaults to: nil) —

    Scheduled delivery time for message in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.

Returns:

  • (Message) 


355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/appwrite/services/messaging.rb', line 355

def update_sms(message_id:, topics: nil, users: nil, targets: nil, content: nil, draft: nil, scheduled_at: nil)
    api_path = '/messaging/messages/sms/{messageId}'
        .gsub('{messageId}', message_id)

    if message_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "messageId"')
    end

    api_params = {
        topics: topics,
        users: users,
        targets: targets,
        content: content,
        draft: draft,
        scheduledAt: scheduled_at,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Message
    )

end

#update_smtp_provider(provider_id:, name: nil, host: nil, port: nil, username: nil, password: nil, encryption: nil, auto_tls: nil, mailer: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil) ⇒ Provider

Update a SMTP provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • host (String) (defaults to: nil) —

    SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as ‘smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465“`. Hosts will be tried in order.

  • port (Integer) (defaults to: nil) —

    SMTP port.

  • username (String) (defaults to: nil) —

    Authentication username.

  • password (String) (defaults to: nil) —

    Authentication password.

  • encryption (SmtpEncryption) (defaults to: nil) —

    Encryption type. Can be ‘ssl’ or ‘tls’

  • [] —

    auto_tls Enable SMTP AutoTLS feature.

  • mailer (String) (defaults to: nil) —

    The value to use for the X-Mailer header.

  • from_name (String) (defaults to: nil) —

    Sender Name.

  • from_email (String) (defaults to: nil) —

    Sender email address.

  • reply_to_name (String) (defaults to: nil) —

    Name set in the Reply To field for the mail. Default value is Sender Name.

  • reply_to_email (String) (defaults to: nil) —

    Email set in the Reply To field for the mail. Default value is Sender Email.

  • [] —

    enabled Set as enabled.

Returns:

  • (Provider) 


1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/appwrite/services/messaging.rb', line 1280

def update_smtp_provider(provider_id:, name: nil, host: nil, port: nil, username: nil, password: nil, encryption: nil, auto_tls: nil, mailer: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
    api_path = '/messaging/providers/smtp/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        host: host,
        port: port,
        username: username,
        password: password,
        encryption: encryption,
        autoTLS: auto_tls,
        mailer: mailer,
        fromName: from_name,
        fromEmail: from_email,
        replyToName: reply_to_name,
        replyToEmail: reply_to_email,
        enabled: enabled,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_telesign_provider(provider_id:, name: nil, enabled: nil, customer_id: nil, api_key: nil, from: nil) ⇒ Provider

Update a Telesign provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • customer_id (String) (defaults to: nil) —

    Telesign customer ID.

  • api_key (String) (defaults to: nil) —

    Telesign API key.

  • from (String) (defaults to: nil) —

    Sender number.

Returns:

  • (Provider) 


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/appwrite/services/messaging.rb', line 1374

def update_telesign_provider(provider_id:, name: nil, enabled: nil, customer_id: nil, api_key: nil, from: nil)
    api_path = '/messaging/providers/telesign/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        customerId: customer_id,
        apiKey: api_key,
        from: from,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_textmagic_provider(provider_id:, name: nil, enabled: nil, username: nil, api_key: nil, from: nil) ⇒ Provider

Update a Textmagic provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • username (String) (defaults to: nil) —

    Textmagic username.

  • api_key (String) (defaults to: nil) —

    Textmagic apiKey.

  • from (String) (defaults to: nil) —

    Sender number.

Returns:

  • (Provider) 


1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
 
# File 'lib/appwrite/services/messaging.rb', line 1460

def update_textmagic_provider(provider_id:, name: nil, enabled: nil, username: nil, api_key: nil, from: nil)
    api_path = '/messaging/providers/textmagic/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        username: username,
        apiKey: api_key,
        from: from,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_topic(topic_id:, name: nil, subscribe: nil) ⇒ Topic

Update a topic by its unique ID.

Parameters:

  • topic_id (String) —

    Topic ID.

  • name (String) (defaults to: nil) —

    Topic Name.

  • subscribe (Array) (defaults to: nil) —

    An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.

Returns:

  • (Topic) 


1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/appwrite/services/messaging.rb', line 1900

def update_topic(topic_id:, name: nil, subscribe: nil)
    api_path = '/messaging/topics/{topicId}'
        .gsub('{topicId}', topic_id)

    if topic_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "topicId"')
    end

    api_params = {
        name: name,
        subscribe: subscribe,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Topic
    )

end

#update_twilio_provider(provider_id:, name: nil, enabled: nil, account_sid: nil, auth_token: nil, from: nil) ⇒ Provider

Update a Twilio provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • account_sid (String) (defaults to: nil) —

    Twilio account secret ID.

  • auth_token (String) (defaults to: nil) —

    Twilio authentication token.

  • from (String) (defaults to: nil) —

    Sender number.

Returns:

  • (Provider) 


1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
 
# File 'lib/appwrite/services/messaging.rb', line 1546

def update_twilio_provider(provider_id:, name: nil, enabled: nil, account_sid: nil, auth_token: nil, from: nil)
    api_path = '/messaging/providers/twilio/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        accountSid: ,
        authToken: auth_token,
        from: from,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end

#update_vonage_provider(provider_id:, name: nil, enabled: nil, api_key: nil, api_secret: nil, from: nil) ⇒ Provider

Update a Vonage provider by its unique ID.

Parameters:

  • provider_id (String) —

    Provider ID.

  • name (String) (defaults to: nil) —

    Provider name.

  • [] —

    enabled Set as enabled.

  • api_key (String) (defaults to: nil) —

    Vonage API key.

  • api_secret (String) (defaults to: nil) —

    Vonage API secret.

  • from (String) (defaults to: nil) —

    Sender number.

Returns:

  • (Provider) 


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/appwrite/services/messaging.rb', line 1632

def update_vonage_provider(provider_id:, name: nil, enabled: nil, api_key: nil, api_secret: nil, from: nil)
    api_path = '/messaging/providers/vonage/{providerId}'
        .gsub('{providerId}', provider_id)

    if provider_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "providerId"')
    end

    api_params = {
        name: name,
        enabled: enabled,
        apiKey: api_key,
        apiSecret: api_secret,
        from: from,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Provider
    )

end