customerio 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315eb46a7117b5e0408a57f896c49bf7336003db16439780d119ddc8e4015a1a
-  data.tar.gz: 41ddd049e7978bb75e8c792dda18090e9ffe7e64a85079a2e4d56cbc097feb48
+  metadata.gz: db681e306c4d3d780852f5aa18546de96e63bde2149e7ea92e44e64f07ef2fdf
+  data.tar.gz: 695ef4db24d55f7da1ece9ac0f95e6813bd179db20fd15dc034b1a7660c9682f
 SHA512:
-  metadata.gz: 895cf3b64c4f57ed636a2a80c7c356eb4387edd2f5c5c65d1d46b0a418330333f84f66407ef8d844adeeda13d6089ee00d3ce60d22790d17fa246622c291f9d9
-  data.tar.gz: f213766bfb67f9ad8d570292816bba51e7c6863fbcc15d98e4f1f75d80953b00813e9c531c5b84d013f5531e23f4f623dbe77e5d054ea1ccc125608ef00a343b
+  metadata.gz: 630d232d3851e8abfaa1fa3c0806dda7496199f3d928d26e315d3b2c9bc234c9deeafff2c3d332b624664e355dcaaa54caf935337e8464073c08cfc4ad00a06a
+  data.tar.gz: 0d58478028485b1881e1996cfcc545bae0f33304698a84f2df2288a838ef8bc650e905b55ae80e51c84a7328930ba5bc4dc07051d551f28092a770143a47677e

data/lib/customerio/api.rb

@@ -56,6 +56,21 @@ module Customerio
       end
     end
 
+    def send_inbox_message(req)
+      raise "request must be an instance of Customerio::SendInboxMessageRequest" unless req.is_a?(Customerio::SendInboxMessageRequest)
+      response = @client.request(:post, send_inbox_message_path, req.message)
+
+      case response
+      when Net::HTTPSuccess then
+        JSON.parse(response.body)
+      when Net::HTTPBadRequest then
+        json = JSON.parse(response.body)
+        raise Customerio::InvalidResponse.new(response.code, json['meta']['error'], response)
+      else
+        raise InvalidResponse.new(response.code, response.body)
+      end
+    end
+
     private
 
     def send_email_path
@@ -69,5 +84,9 @@ module Customerio
     def send_sms_path
       "/v1/send/sms"
     end
+
+    def send_inbox_message_path
+      "/v1/send/inbox_message"
+    end
   end
 end

data/lib/customerio/requests/send_inbox_message_request.rb

@@ -0,0 +1,31 @@
+require 'base64'
+
+module Customerio
+  class SendInboxMessageRequest
+    attr_reader :message
+
+    def initialize(opts)
+      @message = opts.delete_if { |field| invalid_field?(field) }
+    end
+
+    private
+
+    REQUIRED_FIELDS = %i(identifiers transactional_message_id)
+
+    OPTIONAL_FIELDS = %i(
+      message_data
+      disable_message_retention
+      queue_draft
+      send_at
+      language
+    )
+
+    def invalid_field?(field)
+      !REQUIRED_FIELDS.include?(field) && !OPTIONAL_FIELDS.include?(field)
+    end
+
+    def encode(data)
+      Base64.strict_encode64(data)
+    end
+  end
+end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "5.4.0"
+  VERSION = "5.5.0"
 end

data/lib/customerio.rb

@@ -7,6 +7,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_inbox_message_request"
   require "customerio/api"
   require "customerio/param_encoder"
 end

data/spec/api_client_spec.rb

@@ -311,4 +311,63 @@ describe Customerio::APIClient do
       )
     end
   end
+
+  describe "#send_inbox_message" do
+    it "sends a POST request to the /api/send/inbox_message path" do
+      req = Customerio::SendInboxMessageRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/inbox_message'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 200, body: { delivery_id: 1 }.to_json, headers: {})
+
+      client.send_inbox_message(req).should eq({ "delivery_id" => 1 })
+    end
+
+    it "handles validation failures (400)" do
+      req = Customerio::SendInboxMessageRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      err_json = { meta: { error: "example error" } }.to_json
+
+      stub_request(:post, api_uri('/v1/send/inbox_message'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 400, body: err_json, headers: {})
+
+      lambda { client.send_inbox_message(req) }.should(
+        raise_error(Customerio::InvalidResponse) { |error|
+          error.message.should eq "example error"
+          error.code.should eq "400"
+        }
+      )
+    end
+
+    it "handles other failures (5xx)" do
+      req = Customerio::SendInboxMessageRequest.new(
+        identifiers: {
+          id: 'c1',
+        },
+        transactional_message_id: 1,
+      )
+
+      stub_request(:post, api_uri('/v1/send/inbox_message'))
+        .with(headers: request_headers, body: req.message)
+        .to_return(status: 500, body: "Server unavailable", headers: {})
+
+      lambda { client.send_inbox_message(req) }.should(
+        raise_error(Customerio::InvalidResponse) { |error|
+          error.message.should eq "Server unavailable"
+          error.code.should eq "500"
+        }
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-13 00:00:00.000000000 Z
+date: 2026-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -131,6 +131,7 @@ files:
 - lib/customerio/param_encoder.rb
 - lib/customerio/regions.rb
 - lib/customerio/requests/send_email_request.rb
+- lib/customerio/requests/send_inbox_message_request.rb
 - lib/customerio/requests/send_push_request.rb
 - lib/customerio/requests/send_sms_request.rb
 - lib/customerio/version.rb