trycourier 4.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c04a056977df7fe1d6cb3728f5cd20d3146303a4aa290ab736cd8b0b5b48cc
-  data.tar.gz: 2f8b70b8eadaa154cec067afbbb503ed808278ebed1f867981790a661ea027c6
+  metadata.gz: 8f245290616d8bf259ac1cede4dc337f5f14ec04d8d527d96a630b854a6bb3f6
+  data.tar.gz: 859658f71041732efff2b2a4122e4cc493878077bcbc7c769fc1158210ede6b6
 SHA512:
-  metadata.gz: 17ddc44b894c1652b8ab7fe614d2bcf99c936e9d36f124c1121ee913dfff46d6674c9672c1f3192c160fae83c76eaa1bd50382bcb9aff1963978ace8bf883bb2
-  data.tar.gz: c0ce826de197896c96af433c3089989bb133d3c53dba59509e828fb52145c823bf0e77f9323004a22b87f94c073d3efe515caace6939ba167e8afae4c29d59d5
+  metadata.gz: 26091252593b2a6526080c3b11bb9b04aa7cff078329cd19f274d8650d97ad6ee590debcb1896c34c339229c578a7deac57d42ae1f2ac53743796a90889fbefd
+  data.tar.gz: ae438abbbb1d3346d10be702d37e0fac2be5ec5a1242dc80992228b0c87375655e50ec42dfb2e657825db73d4974d7a89c46737f81e28114c84bf06b6bc75bb5

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 4.6.0 (2026-01-08)
+
+Full Changelog: [v4.5.0...v4.6.0](https://github.com/trycourier/courier-ruby/compare/v4.5.0...v4.6.0)
+
+### Features
+
+* **api:** remove audit_events, automations, brands, bulk, inbound, translations endpoints ([f9f04c1](https://github.com/trycourier/courier-ruby/commit/f9f04c1760b4dceb5ed966449ddb19cd4bc72182))
+
+## 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)

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.4.0"
+gem "trycourier", "~> 4.6.0"
 ```
 
 <!-- x-release-please-end -->
@@ -221,25 +221,25 @@ courier.send_.message(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :OPTED_OUT
-puts(Trycourier::SubscriptionTopicNew::Status::OPTED_OUT)
+# :published
+puts(Trycourier::AutomationListParams::Version::PUBLISHED)
 
-# Revealed type: `T.all(Trycourier::SubscriptionTopicNew::Status, Symbol)`
-T.reveal_type(Trycourier::SubscriptionTopicNew::Status::OPTED_OUT)
+# Revealed type: `T.all(Trycourier::AutomationListParams::Version, Symbol)`
+T.reveal_type(Trycourier::AutomationListParams::Version::PUBLISHED)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-courier.tenants.preferences.items.update(
-  status: Trycourier::SubscriptionTopicNew::Status::OPTED_OUT,
+courier.automations.list(
+  version: Trycourier::AutomationListParams::Version::PUBLISHED,
   # …
 )
 
 # Literal values are also permissible:
-courier.tenants.preferences.items.update(
-  status: :OPTED_OUT,
+courier.automations.list(
+  version: :published,
   # …
 )
 ```

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/automation_list_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Automations#list
+    class AutomationListParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A cursor token for pagination. Use the cursor from the previous response to
+      #   fetch the next page of results.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute version
+      #   The version of templates to retrieve. Accepted values are published (for
+      #   published templates) or draft (for draft templates). Defaults to published.
+      #
+      #   @return [Symbol, Trycourier::Models::AutomationListParams::Version, nil]
+      optional :version, enum: -> { Trycourier::AutomationListParams::Version }
+
+      # @!method initialize(cursor: nil, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::AutomationListParams} for more details.
+      #
+      #   @param cursor [String] A cursor token for pagination. Use the cursor from the previous response to fetc
+      #
+      #   @param version [Symbol, Trycourier::Models::AutomationListParams::Version] The version of templates to retrieve. Accepted values are published (for publish
+      #
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+
+      # The version of templates to retrieve. Accepted values are published (for
+      # published templates) or draft (for draft templates). Defaults to published.
+      module Version
+        extend Trycourier::Internal::Type::Enum
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/automation_template.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class AutomationTemplate < Trycourier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the automation template.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute name
+      #   The name of the automation template.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute version
+      #   The version of the template published, draft.
+      #
+      #   @return [Symbol, Trycourier::Models::AutomationTemplate::Version]
+      required :version, enum: -> { Trycourier::AutomationTemplate::Version }
+
+      # @!attribute created_at
+      #   ISO 8601 timestamp when the template was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute updated_at
+      #   ISO 8601 timestamp when the template was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt
+
+      # @!method initialize(id:, name:, version:, created_at: nil, updated_at: nil)
+      #   @param id [String] The unique identifier of the automation template.
+      #
+      #   @param name [String] The name of the automation template.
+      #
+      #   @param version [Symbol, Trycourier::Models::AutomationTemplate::Version] The version of the template published, draft.
+      #
+      #   @param created_at [Time] ISO 8601 timestamp when the template was created.
+      #
+      #   @param updated_at [Time] ISO 8601 timestamp when the template was last updated.
+
+      # The version of the template published, draft.
+      #
+      # @see Trycourier::Models::AutomationTemplate#version
+      module Version
+        extend Trycourier::Internal::Type::Enum
+
+        PUBLISHED = :published
+        DRAFT = :draft
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/automation_template_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Automations#list
+    class AutomationTemplateListResponse < Trycourier::Internal::Type::BaseModel
+      # @!attribute cursor
+      #   A cursor token for pagination. Present when there are more results available.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute templates
+      #
+      #   @return [Array<Trycourier::Models::AutomationTemplate>, nil]
+      optional :templates, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::AutomationTemplate] }
+
+      # @!method initialize(cursor: nil, templates: nil)
+      #   @param cursor [String] A cursor token for pagination. Present when there are more results available.
+      #
+      #   @param templates [Array<Trycourier::Models::AutomationTemplate>]
+    end
+  end
+end

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