trycourier 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bd120c1a6bd12bf0960fae9661848fe6a6e41c2782baa6eb3ae166882c428b
-  data.tar.gz: 4d2f6ba063c1dfb2270feaab7c0763c7aafb88920ea1f327d91bdc681abbc975
+  metadata.gz: b109ca392cd8dc7760b016a016c6014cdda3aa46e86443e23f89b302e14d547e
+  data.tar.gz: e4aaccf736dd71f8903bd477b10aacce0d2f341254004edcd023679797be7aed
 SHA512:
-  metadata.gz: 56c1130d7caa6e4484ce56ff35dbce92518cd5559c32cf2895a18c45227bd81c49f27fb376e45d8c610eef5c49c2857265233028a5020bcf76a8f8a8630cb671
-  data.tar.gz: 1680c9bf19b28f762ce9ec73c01c33f6ae7035a0a824f4a013f5d489471c54ef2dde450f85729aba4658ff7b8db129f6e898b1bc77bd3cce8e3e867c5a03807f
+  metadata.gz: ac34939a4b50cb50b6df3650934fc8143b440add045aaf046ffb8044ce9ab3e867d322e06bcb1b1d7b5004470068c7efd4430e2e7cb732a2b2f6f917eaecbc12
+  data.tar.gz: 6b9dbd28970b57e097cc6d26f6d2eaa07c3fbc1b2160737ae3dbd2bc2aff70e2e547ad2c37744eba76e44bad54d01bfc2b3dcb09eedd5972034c45371a21cbec

data/CHANGELOG.md

@@ -5,7 +5,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [v1.7.0] - 2023-06-22
+
+- Support for cancel message API
+
+## [v1.6.0] - 2022-07-25
+
+- Support for audit events API
+
 ## [v1.5.0] - 2022-03-28
+
 - Support for audiences API
 
 ## [v1.4.0] - 2022-01-31
@@ -94,7 +103,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release by @troygoode
 
-[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.5.0...HEAD
+[unreleased]: https://github.com/trycourier/courier-ruby/compare/v1.6.0...HEAD
+[v1.6.0]: https://github.com/trycourier/courier-ruby/compare/v1.5.0...v1.6.0
 [v1.5.0]: https://github.com/trycourier/courier-ruby/compare/v1.4.0...v1.5.0
 [v1.4.0]: https://github.com/trycourier/courier-ruby/compare/v1.3.0...v1.4.0
 [v1.3.0]: https://github.com/trycourier/courier-ruby/compare/v1.2.0...v1.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trycourier (1.5.0)
+    trycourier (1.7.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -107,6 +107,7 @@ res = client.send_message({
         "utm" => {
           "source" => "Ruby"
         },
+        "tags" => ["tag-1", "tag-2"],
         "trace_id" => "feed-me-hungry"
       }
     }
@@ -118,6 +119,75 @@ rescue Courier::CourierAPIError => re #error sent from from the API
 end
 ```
 
+### Sending a message to an individual with granular metadata
+
+```ruby
+client = Courier::Client.new "your-auth-token" # or set via COURIER_AUTH_TOKEN env var
+res = client.send_message({
+    "message" => {
+      "to" => {
+        "email" => "foo@bar.com"
+      },
+      "content" => {
+			  "version" => "2020-01-01",
+        "elements" => [
+				  {
+            "type" => "text",
+            "content" => "Thanks for signing up, {{name}}"
+          },
+          {
+            "type" => "action",
+            "content" => "Click Me!",
+            "href" => "https://www.example.com"
+          }
+        ]
+		  },
+      "routing" => {
+        "method" => "all",
+        "channels" => [
+          "email"
+        ]
+		  },
+      "data" => {
+        "name" => "Ruby"
+      },
+      "metadata" => {
+        "utm" => {
+          "source" => "Ruby"
+        },
+      },
+      "channels" => {
+        "email" => {
+          "routing_method" => "all",
+          "providers" => [
+            "sendgrid",
+            "mailjet"
+          ],
+          "metadata" => {
+            "utm" => {
+              "medium" => "email"
+            }
+          }
+        }
+      },
+      "providers" => {
+        "sendgrid" => {
+          "metadata" => {
+            "utm" => {
+              "source" => "sendgrid"
+            }
+          }
+        }
+      }
+    }
+  })
+  puts res.code # the HTTP response code
+  puts res.request_id # if the code is 202, this will be the Courier request ID for this message
+rescue Courier::CourierAPIError => re #error sent from from the API
+  puts re.message
+end
+```
+
 ## Advanced Usage
 
 ### Lists
@@ -507,6 +577,20 @@ rescue Courier::CourierAPIError => re #error sent from from the API
 end
 ```
 
+### Audit Events
+
+```Ruby
+"""
+Example: List audit events
+"""
+resp = client.audit_events.list()
+
+"""
+Example: Get a specific audit event
+"""
+resp = client.audit_events.get(audit_event_id: "audit-event-id")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/trycourier/audit_events.rb

@@ -0,0 +1,27 @@
+module Courier
+  class AuditEvents
+    KEY = "/audit-events"
+
+    def initialize(session)
+      @session = session
+    end
+
+    def get(audit_event_id:)
+      path = "#{KEY}/#{audit_event_id}"
+      res = @session.send(path, "GET")
+      ErrorHandler.check_err(res)
+    end
+
+    def list(cursor: nil)
+      path = "#{KEY}"
+
+      params = {}
+      if cursor
+        params["cursor"] = cursor
+      end
+
+      res = @session.send(path, "GET", params: params)
+      ErrorHandler.check_err(res)
+    end
+  end
+end

data/lib/trycourier/messages.rb

@@ -38,6 +38,12 @@ module Courier
       ErrorHandler.check_err(res)
     end
 
+    def cancel(message_id:)
+      path = "#{KEY}/#{message_id}/cancel"
+      res = @session.send(path, "POST")
+      ErrorHandler.check_err(res)
+    end
+
     def get_history(message_id:, type: nil)
       path = "#{KEY}/#{message_id}/history"
       params = {}

data/lib/trycourier/version.rb

@@ -1,3 +1,3 @@
 module Courier
-  VERSION = "1.5.0"
+  VERSION = "1.7.0"
 end

data/lib/trycourier.rb

@@ -7,6 +7,7 @@ require "trycourier/messages"
 require "trycourier/automations"
 require "trycourier/bulk"
 require "trycourier/audiences"
+require "trycourier/audit_events"
 require "trycourier/version"
 require "trycourier/exceptions"
 
@@ -65,6 +66,7 @@ module Courier
       @automations = Courier::Automations.new(@session)
       @bulk = Courier::Bulk.new(@session)
       @audiences = Courier::Audiences.new(@session)
+      @audit_events = Courier::AuditEvents.new(@session)
     end
 
     def send(body)
@@ -135,6 +137,7 @@ module Courier
 
     attr_reader :audiences
 
+    attr_reader :audit_events
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Courier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -62,6 +62,7 @@ files:
 - bin/setup
 - lib/trycourier.rb
 - lib/trycourier/audiences.rb
+- lib/trycourier/audit_events.rb
 - lib/trycourier/automations.rb
 - lib/trycourier/brands.rb
 - lib/trycourier/bulk.rb