trycourier 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90938239a2ad14d3834d90316b9e134aaa3f1173482cc20006a47281b169eaaf
-  data.tar.gz: 88885b2fe15f0a98fdfe61c5803795b8b717f93f2be1486332e07828466ab994
+  metadata.gz: 50b24baf1344688ba29d949d04f66b3841f3272ab0db0e353d9364a3441d39b6
+  data.tar.gz: a0b247a913ade31c0aa104718b3607a5546367a3f69febb9a2d377d68e6dbe0b
 SHA512:
-  metadata.gz: 6df42006118d203008458dcc1012e35f903e53039ee881d60cf90b532db7f9a2565f77ffe82a5dc32b1bf9508750470d2fbc88dc3f855abc477c2a3f0df6bf3c
-  data.tar.gz: 719003467281f8692c54d450e7830a85ab4470cb68e80eb2a2962acc46980999bf68a321f7e8afccbe85178909f2cee53e6a2a8295ee1104a6c931f6f1fb212f
+  metadata.gz: 4549c791b9b0c8b1f26cca857c6ea4fccacb889d13fce5a75976f4436c987d52ef43e31c1085f79eb645f325f31263c239f1a5d2dc88c79275483137805e0928
+  data.tar.gz: dfc09375e3facc38b137ed1da33b7b3624751c8e10727d333f00d27fe9efddcf34a83e337aa4dfcfc0cc988f04a48f393b74437e00fb992544bc43710a6ba5ca

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 4.5.0 (2025-12-29)
+
+Full Changelog: [v4.4.0...v4.5.0](https://github.com/trycourier/courier-ruby/compare/v4.4.0...v4.5.0)
+
+### Features
+
+* **api:** add slack/msteams/pagerduty/webhook/audience/list recipient types ([56278ef](https://github.com/trycourier/courier-ruby/commit/56278ef7d0582bfba2e2122f9682c1282f25109d))
+
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([7af6435](https://github.com/trycourier/courier-ruby/commit/7af6435d8426c69cb9c07d263d3363526508be7d))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([6288d57](https://github.com/trycourier/courier-ruby/commit/6288d578db512479a70098e529a26a0e29139918))
+
+## 4.4.0 (2025-12-16)
+
+Full Changelog: [v4.3.0...v4.4.0](https://github.com/trycourier/courier-ruby/compare/v4.3.0...v4.4.0)
+
+### Features
+
+* Add timezone field to Delay schema ([980df61](https://github.com/trycourier/courier-ruby/commit/980df617cffc47a231bac77a4250ef4e409cb57c))
+* Update bulk API spec: make event required, document profile.email req… ([73718b3](https://github.com/trycourier/courier-ruby/commit/73718b3e6c13e0a3ac1bc5487eb07953f435a956))
+
 ## 4.3.0 (2025-12-08)
 
 Full Changelog: [v4.2.0...v4.3.0](https://github.com/trycourier/courier-ruby/compare/v4.2.0...v4.3.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 4.3.0"
+gem "trycourier", "~> 4.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/trycourier/internal/transport/pooled_net_requester.rb

@@ -153,17 +153,19 @@ module Trycourier
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

data/lib/trycourier/internal/type/base_model.rb

@@ -438,9 +438,10 @@ module Trycourier
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `channel_preference` is a `Trycourier::ChannelPreference`
-        #   channel_preference => {
-        #     channel: channel
+        #   # `airship_profile` is a `Trycourier::AirshipProfile`
+        #   airship_profile => {
+        #     audience: audience,
+        #     device_types: device_types
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/trycourier/internal/type/union.rb

@@ -6,16 +6,14 @@ module Trycourier
       # @api private
       #
       # @example
-      #   # `elemental_node` is a `Trycourier::ElementalNode`
-      #   case elemental_node
-      #   when Trycourier::ElementalTextNodeWithType
-      #     # ...
-      #   when Trycourier::ElementalMetaNodeWithType
-      #     # ...
-      #   when Trycourier::ElementalChannelNodeWithType
-      #     # ...
+      #   # `discord` is a `Trycourier::Discord`
+      #   case discord
+      #   when Trycourier::SendToChannel
+      #     puts(discord.channel_id)
+      #   when Trycourier::SendDirectMessage
+      #     puts(discord.user_id)
       #   else
-      #     puts(elemental_node)
+      #     puts(discord)
       #   end
       module Union
         include Trycourier::Internal::Type::Converter

data/lib/trycourier/internal/util.rb

@@ -657,7 +657,8 @@ module Trycourier
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in Trycourier::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module Trycourier
           in Trycourier::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/trycourier/models/airship_profile.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class AirshipProfile < Trycourier::Internal::Type::BaseModel
+      # @!attribute audience
+      #
+      #   @return [Trycourier::Models::AirshipProfileAudience]
+      required :audience, -> { Trycourier::AirshipProfileAudience }
+
+      # @!attribute device_types
+      #
+      #   @return [Array<String>]
+      required :device_types, Trycourier::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(audience:, device_types:)
+      #   @param audience [Trycourier::Models::AirshipProfileAudience]
+      #   @param device_types [Array<String>]
+    end
+  end
+end

data/lib/trycourier/models/airship_profile_audience.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class AirshipProfileAudience < Trycourier::Internal::Type::BaseModel
+      # @!attribute named_user
+      #
+      #   @return [String]
+      required :named_user, String
+
+      # @!method initialize(named_user:)
+      #   @param named_user [String]
+    end
+  end
+end

data/lib/trycourier/models/audience.rb

@@ -24,8 +24,8 @@ module Trycourier
       # @!attribute filter
       #   A single filter to use for filtering
       #
-      #   @return [Trycourier::Models::Filter]
-      required :filter, -> { Trycourier::Filter }
+      #   @return [Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig]
+      required :filter, union: -> { Trycourier::Filter }
 
       # @!attribute name
       #   The name of the audience
@@ -45,7 +45,7 @@ module Trycourier
       #
       #   @param description [String] A description of the audience
       #
-      #   @param filter [Trycourier::Models::Filter] A single filter to use for filtering
+      #   @param filter [Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig] A single filter to use for filtering
       #
       #   @param name [String] The name of the audience
       #

data/lib/trycourier/models/audience_filter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class AudienceFilter < Trycourier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   Send to users only if they are member of the account
+      #
+      #   @return [Symbol, Trycourier::Models::AudienceFilter::Operator]
+      required :operator, enum: -> { Trycourier::AudienceFilter::Operator }
+
+      # @!attribute path
+      #
+      #   @return [Symbol, Trycourier::Models::AudienceFilter::Path]
+      required :path, enum: -> { Trycourier::AudienceFilter::Path }
+
+      # @!attribute value
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(operator:, path:, value:)
+      #   @param operator [Symbol, Trycourier::Models::AudienceFilter::Operator] Send to users only if they are member of the account
+      #
+      #   @param path [Symbol, Trycourier::Models::AudienceFilter::Path]
+      #
+      #   @param value [String]
+
+      # Send to users only if they are member of the account
+      #
+      # @see Trycourier::Models::AudienceFilter#operator
+      module Operator
+        extend Trycourier::Internal::Type::Enum
+
+        MEMBER_OF = :MEMBER_OF
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Trycourier::Models::AudienceFilter#path
+      module Path
+        extend Trycourier::Internal::Type::Enum
+
+        ACCOUNT_ID = :account_id
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/audience_recipient.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class AudienceRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute audience_id
+      #   A unique identifier associated with an Audience. A message will be sent to each
+      #   user in the audience.
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute filters
+      #
+      #   @return [Array<Trycourier::Models::AudienceFilter>, nil]
+      optional :filters, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::AudienceFilter] }, nil?: true
+
+      # @!method initialize(audience_id:, data: nil, filters: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::AudienceRecipient} for more details.
+      #
+      #   Send to all users in an audience
+      #
+      #   @param audience_id [String] A unique identifier associated with an Audience. A message will be sent to each
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #
+      #   @param filters [Array<Trycourier::Models::AudienceFilter>, nil]
+    end
+  end
+end

data/lib/trycourier/models/audience_update_params.rb

@@ -16,8 +16,8 @@ module Trycourier
       # @!attribute filter
       #   A single filter to use for filtering
       #
-      #   @return [Trycourier::Models::Filter, nil]
-      optional :filter, -> { Trycourier::Filter }, nil?: true
+      #   @return [Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig, nil]
+      optional :filter, union: -> { Trycourier::Filter }, nil?: true
 
       # @!attribute name
       #   The name of the audience
@@ -28,7 +28,7 @@ module Trycourier
       # @!method initialize(description: nil, filter: nil, name: nil, request_options: {})
       #   @param description [String, nil] A description of the audience
       #
-      #   @param filter [Trycourier::Models::Filter, nil] A single filter to use for filtering
+      #   @param filter [Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig, nil] A single filter to use for filtering
       #
       #   @param name [String, nil] The name of the audience
       #

data/lib/trycourier/models/bulk_create_job_params.rb

@@ -8,12 +8,21 @@ module Trycourier
       include Trycourier::Internal::Type::RequestParameters
 
       # @!attribute message
+      #   Bulk message definition. Supports two formats:
       #
-      #   @return [Trycourier::Models::InboundBulkMessage::InboundBulkTemplateMessage, Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage]
-      required :message, union: -> { Trycourier::InboundBulkMessage }
+      #   - V1 format: Requires `event` field (event ID or notification ID)
+      #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+      #     content) in addition to `event`
+      #
+      #   @return [Trycourier::Models::InboundBulkMessage]
+      required :message, -> { Trycourier::InboundBulkMessage }
 
       # @!method initialize(message:, request_options: {})
-      #   @param message [Trycourier::Models::InboundBulkMessage::InboundBulkTemplateMessage, Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage]
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::BulkCreateJobParams} for more details.
+      #
+      #   @param message [Trycourier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
+      #
       #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/trycourier/models/bulk_retrieve_job_response.rb

@@ -15,9 +15,14 @@ module Trycourier
       # @see Trycourier::Models::BulkRetrieveJobResponse#job
       class Job < Trycourier::Internal::Type::BaseModel
         # @!attribute definition
+        #   Bulk message definition. Supports two formats:
         #
-        #   @return [Trycourier::Models::InboundBulkMessage::InboundBulkTemplateMessage, Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage]
-        required :definition, union: -> { Trycourier::InboundBulkMessage }
+        #   - V1 format: Requires `event` field (event ID or notification ID)
+        #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+        #     content) in addition to `event`
+        #
+        #   @return [Trycourier::Models::InboundBulkMessage]
+        required :definition, -> { Trycourier::InboundBulkMessage }
 
         # @!attribute enqueued
         #
@@ -40,10 +45,17 @@ module Trycourier
         required :status, enum: -> { Trycourier::Models::BulkRetrieveJobResponse::Job::Status }
 
         # @!method initialize(definition:, enqueued:, failures:, received:, status:)
-        #   @param definition [Trycourier::Models::InboundBulkMessage::InboundBulkTemplateMessage, Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage]
+        #   Some parameter documentations has been truncated, see
+        #   {Trycourier::Models::BulkRetrieveJobResponse::Job} for more details.
+        #
+        #   @param definition [Trycourier::Models::InboundBulkMessage] Bulk message definition. Supports two formats:
+        #
         #   @param enqueued [Integer]
+        #
         #   @param failures [Integer]
+        #
         #   @param received [Integer]
+        #
         #   @param status [Symbol, Trycourier::Models::BulkRetrieveJobResponse::Job::Status]
 
         # @see Trycourier::Models::BulkRetrieveJobResponse::Job#status

data/lib/trycourier/models/device_type.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    DeviceType = String
+  end
+end

data/lib/trycourier/models/discord.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Discord
+      extend Trycourier::Internal::Type::Union
+
+      variant -> { Trycourier::SendToChannel }
+
+      variant -> { Trycourier::SendDirectMessage }
+
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SendToChannel, Trycourier::Models::SendDirectMessage)]
+    end
+  end
+end

data/lib/trycourier/models/expo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Expo
+      extend Trycourier::Internal::Type::Union
+
+      variant -> { Trycourier::Token }
+
+      variant -> { Trycourier::MultipleTokens }
+
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::Token, Trycourier::Models::MultipleTokens)]
+    end
+  end
+end

data/lib/trycourier/models/filter.rb

@@ -2,61 +2,18 @@
 
 module Trycourier
   module Models
-    class Filter < Trycourier::Internal::Type::BaseModel
-      # @!attribute operator
-      #   The operator to use for filtering
-      #
-      #   @return [Symbol, Trycourier::Models::Filter::Operator]
-      required :operator, enum: -> { Trycourier::Filter::Operator }
+    # A single filter to use for filtering
+    module Filter
+      extend Trycourier::Internal::Type::Union
 
-      # @!attribute path
-      #   The attribe name from profile whose value will be operated against the filter
-      #   value
-      #
-      #   @return [String]
-      required :path, String
-
-      # @!attribute value
-      #   The value to use for filtering
-      #
-      #   @return [String]
-      required :value, String
-
-      # @!method initialize(operator:, path:, value:)
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::Models::Filter} for more details.
-      #
-      #   @param operator [Symbol, Trycourier::Models::Filter::Operator] The operator to use for filtering
-      #
-      #   @param path [String] The attribe name from profile whose value will be operated against the filter va
-      #
-      #   @param value [String] The value to use for filtering
+      # A single filter to use for filtering
+      variant -> { Trycourier::SingleFilterConfig }
 
       # The operator to use for filtering
-      #
-      # @see Trycourier::Models::Filter#operator
-      module Operator
-        extend Trycourier::Internal::Type::Enum
-
-        ENDS_WITH = :ENDS_WITH
-        EQ = :EQ
-        EXISTS = :EXISTS
-        GT = :GT
-        GTE = :GTE
-        INCLUDES = :INCLUDES
-        IS_AFTER = :IS_AFTER
-        IS_BEFORE = :IS_BEFORE
-        LT = :LT
-        LTE = :LTE
-        NEQ = :NEQ
-        OMIT = :OMIT
-        STARTS_WITH = :STARTS_WITH
-        AND = :AND
-        OR = :OR
+      variant -> { Trycourier::NestedFilterConfig }
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig)]
     end
   end
 end

data/lib/trycourier/models/filter_config.rb

@@ -2,61 +2,18 @@
 
 module Trycourier
   module Models
-    class FilterConfig < Trycourier::Internal::Type::BaseModel
-      # @!attribute operator
-      #   The operator to use for filtering
-      #
-      #   @return [Symbol, Trycourier::Models::FilterConfig::Operator]
-      required :operator, enum: -> { Trycourier::FilterConfig::Operator }
+    # A single filter to use for filtering
+    module FilterConfig
+      extend Trycourier::Internal::Type::Union
 
-      # @!attribute path
-      #   The attribe name from profile whose value will be operated against the filter
-      #   value
-      #
-      #   @return [String]
-      required :path, String
-
-      # @!attribute value
-      #   The value to use for filtering
-      #
-      #   @return [String]
-      required :value, String
-
-      # @!method initialize(operator:, path:, value:)
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::Models::FilterConfig} for more details.
-      #
-      #   @param operator [Symbol, Trycourier::Models::FilterConfig::Operator] The operator to use for filtering
-      #
-      #   @param path [String] The attribe name from profile whose value will be operated against the filter va
-      #
-      #   @param value [String] The value to use for filtering
+      # A single filter to use for filtering
+      variant -> { Trycourier::SingleFilterConfig }
 
       # The operator to use for filtering
-      #
-      # @see Trycourier::Models::FilterConfig#operator
-      module Operator
-        extend Trycourier::Internal::Type::Enum
-
-        ENDS_WITH = :ENDS_WITH
-        EQ = :EQ
-        EXISTS = :EXISTS
-        GT = :GT
-        GTE = :GTE
-        INCLUDES = :INCLUDES
-        IS_AFTER = :IS_AFTER
-        IS_BEFORE = :IS_BEFORE
-        LT = :LT
-        LTE = :LTE
-        NEQ = :NEQ
-        OMIT = :OMIT
-        STARTS_WITH = :STARTS_WITH
-        AND = :AND
-        OR = :OR
+      variant -> { Trycourier::NestedFilterConfig }
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SingleFilterConfig, Trycourier::Models::NestedFilterConfig)]
     end
   end
 end