customerio 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901ad05a932585330dd1455f401b1a281b2a3390d2618d0623de62cdd4458988
-  data.tar.gz: 93f962b44d651e177407a68de2ed555fd6fb0a711a3180afda823eee6973b5a7
+  metadata.gz: d7a5b0095c02a4c1b1a5cf0f9edf47a131d20d8f779620c4ddfe82298750ab7c
+  data.tar.gz: 9260b0c869b268a4c511c34fbb291ab82e2bb14a13a341a8b2482be31f50f869
 SHA512:
-  metadata.gz: 9b787fe471290dd64811543d77f24bced641762d894824ffb1d43d671ed0179a6fb536477040bbceb797ca6ccb5f8c6164b085477dfea58db1cac311fd492be3
-  data.tar.gz: e6c251d418be193333c26d07b78f78c61fa61cb3800f5e89dfef9a8c4680a3fcea9a67db09fa793a843172c6daf9ad800a222d6ce2bc0c9c2a2e99e1b633df21
+  metadata.gz: 7aed6bdc54c5f284ccbef64a7992c49cade462dca1513e7d31ee6496c7c884b1db0c8831ef8ff20a9223a3a8364dbcd703726424ce06d3ca4c2d82610d9da82c
+  data.tar.gz: 227a6869e02e98d8d3cdcfdcd3a8c928c7c114f7b7a92d72cd97612f2c3ed877e5d7ad4c160686e2c9e8c659b87b038b549d6e0aa844c9d28721ff8257f4767e

data/README.md

@@ -439,6 +439,42 @@ rescue Customerio::InvalidResponse => e
 end
 ```
 
+#### WhatsApp
+
+Create a new `SendWhatsAppRequest` object containing:
+
+* `transactional_message_id`: the ID or trigger name of the transactional message you want to send.
+* an `identifiers` object containing the `id` or `email` of your recipient. If the profile does not exist, Customer.io creates it.
+
+`to` is the WhatsApp number in E.164 format.
+
+Use `send_whatsapp` referencing your request to send a transactional message. [Learn more about transactional messages and `SendWhatsAppRequest` properties](https://customer.io/docs/transactional-api).
+
+
+```ruby
+require "customerio"
+
+client = Customerio::APIClient.new("your API key", region: Customerio::Regions::US)
+
+request = Customerio::SendWhatsAppRequest.new(
+  transactional_message_id: "3",
+  to: "+15551234567",
+  message_data: {
+    name: "Person",
+  },
+  identifiers: {
+    id: "2",
+  },
+)
+
+begin
+  response = client.send_whatsapp(request)
+  puts response
+rescue Customerio::InvalidResponse => e
+  puts e.code, e.message
+end
+```
+
 ### Trigger Broadcasts
 
 You can trigger [API-triggered broadcasts](https://customer.io/docs/api-triggered-broadcasts/) using the `APIClient`. Create a `TriggerBroadcastRequest` with the broadcast's numeric ID and optional audience/data parameters.

data/lib/customerio/api.rb

@@ -34,6 +34,12 @@ module Customerio
       deliver(send_sms_path, req.message)
     end
 
+    def send_whatsapp(req)
+      validate_request!(req, SendWhatsAppRequest)
+
+      deliver(send_whatsapp_path, req.message)
+    end
+
     def send_inbox_message(req)
       validate_request!(req, SendInboxMessageRequest)
 
@@ -86,6 +92,10 @@ module Customerio
       "/v1/send/sms"
     end
 
+    def send_whatsapp_path
+      "/v1/send/whatsapp"
+    end
+
     def send_inbox_message_path
       "/v1/send/inbox_message"
     end

data/lib/customerio/requests/send_email_request.rb

@@ -13,6 +13,7 @@ module Customerio
       preheader
       from
       reply_to
+      cc
       bcc
       subject
       body

data/lib/customerio/requests/send_whatsapp_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module Customerio
+  class SendWhatsAppRequest
+    REQUIRED_FIELDS = %i[identifiers transactional_message_id].freeze
+
+    OPTIONAL_FIELDS = %i[
+      message_data
+      to
+      disable_message_retention
+      send_to_unsubscribed
+      tracked
+      queue_draft
+      send_at
+      language
+    ].freeze
+
+    attr_reader :message
+
+    def initialize(opts)
+      @message = opts.select { |field, _value| valid_field?(field) }
+      @message[:attachments] ||= {}
+    end
+
+    def attach(name, data, encode: true)
+      raise ArgumentError, "attachment #{name} already exists" if @message[:attachments].key?(name)
+
+      @message[:attachments][name] = encode ? Base64.strict_encode64(data) : data
+    end
+
+    private
+
+    def valid_field?(field)
+      REQUIRED_FIELDS.include?(field) || OPTIONAL_FIELDS.include?(field)
+    end
+  end
+end

data/lib/customerio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Customerio
-  VERSION = "6.1.0"
+  VERSION = "6.2.0"
 end

data/lib/customerio.rb

@@ -9,6 +9,7 @@ module Customerio
   require "customerio/requests/send_email_request"
   require "customerio/requests/send_push_request"
   require "customerio/requests/send_sms_request"
+  require "customerio/requests/send_whatsapp_request"
   require "customerio/requests/send_inbox_message_request"
   require "customerio/requests/send_in_app_request"
   require "customerio/requests/trigger_broadcast_request"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - John Allison
@@ -57,6 +57,7 @@ files:
 - lib/customerio/requests/send_inbox_message_request.rb
 - lib/customerio/requests/send_push_request.rb
 - lib/customerio/requests/send_sms_request.rb
+- lib/customerio/requests/send_whatsapp_request.rb
 - lib/customerio/requests/trigger_broadcast_request.rb
 - lib/customerio/version.rb
 homepage: https://customer.io