trycourier 4.26.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f62c9ba0ccf68a6be91bb13460ab3d7ed38815cd7d2827eba3f0b6c5460598b
-  data.tar.gz: 7d3026d94cc1db562eb020e2e145eacbb67bd5adeada9e29010e60143bdba7ce
+  metadata.gz: 69e1448e2d9e9f4b3e873bd482815aa3b9fad29ecb111705b64771c6b2e7b431
+  data.tar.gz: af2e780f1a0a216e736c414e7e9753c69ad6625a45c80e2b84eae72bf611a8e3
 SHA512:
-  metadata.gz: aed6dce51f5f53597c0b64f394f29cec87c693790996d74d7fc6aaac652a724fe31dda9c3068e0c355888349cf0cb2249db1f8c70126c6f4eea85af0c75c70e6
-  data.tar.gz: b2b494e23b204e033f15d79fe44aa38b601443a515915955c678770878268e68700793bd1542036c405a7e8b0cef24db72d4d33576dd73bdd94d295bc51fe148
+  metadata.gz: 32f36d5e0b55ac49d6279347e6c762f350d814531833a5f57ff0517cbf363e2f07656154eb4bcbb3a73244045d27f5feebd98f2a8244fc1e7cc43249ca04ef76
+  data.tar.gz: 976626752ed191ad270a800c71e7123f5a6d3ca6337097713aca3b32d6ec413304c86a6ab2b251cd4a0fe2177e1c270d3067bab8637eaf1cf4bd117906c9eca8

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [5.0.0](https://github.com/trycourier/courier-ruby/compare/v4.26.2...v5.0.0) (2026-08-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** nest the AWS SNS target_arn under aws_sns on the user profile ([#123](https://github.com/trycourier/courier-ruby/issues/123))
+
+### Features
+
+* **api:** nest the AWS SNS target_arn under aws_sns on the user profile ([#123](https://github.com/trycourier/courier-ruby/issues/123)) ([fcf37c6](https://github.com/trycourier/courier-ruby/commit/fcf37c690e11ccffc8283bbd5791864b405ca20c))
+
 ## [4.26.2](https://github.com/trycourier/courier-ruby/compare/v4.26.1...v4.26.2) (2026-08-13)
 
 

data/README.md

@@ -9,7 +9,7 @@ Add the gem to your `Gemfile`:
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 4.26.2"
+gem "trycourier", "~> 5.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/courier/models/aws_sns.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AwsSns < Courier::Internal::Type::BaseModel
+      # @!attribute target_arn
+      #   The ARN of the SNS platform endpoint, topic, or application to publish to.
+      #
+      #   @return [String]
+      required :target_arn, String
+
+      # @!method initialize(target_arn:)
+      #   Routes a push notification through the AWS SNS provider. The target ARN must be
+      #   nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
+      #   the provider.
+      #
+      #   @param target_arn [String] The ARN of the SNS platform endpoint, topic, or application to publish to.
+    end
+  end
+end

data/lib/courier/models/user_profile.rb

@@ -18,6 +18,14 @@ module Courier
       #   @return [String, nil]
       optional :apn, String, nil?: true
 
+      # @!attribute aws_sns
+      #   Routes a push notification through the AWS SNS provider. The target ARN must be
+      #   nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
+      #   the provider.
+      #
+      #   @return [Courier::Models::AwsSns, nil]
+      optional :aws_sns, -> { Courier::AwsSns }, nil?: true
+
       # @!attribute birthdate
       #
       #   @return [String, nil]
@@ -143,11 +151,6 @@ module Courier
       #   @return [String, nil]
       optional :sub, String, nil?: true
 
-      # @!attribute target_arn
-      #
-      #   @return [String, nil]
-      optional :target_arn, String, nil?: true
-
       # @!attribute updated_at
       #
       #   @return [String, nil]
@@ -163,7 +166,7 @@ module Courier
       #   @return [String, nil]
       optional :zoneinfo, String, nil?: true
 
-      # @!method initialize(address: nil, airship: nil, apn: nil, birthdate: nil, custom: nil, discord: nil, email: nil, email_verified: nil, expo: nil, facebook_psid: nil, family_name: nil, firebase_token: nil, gender: nil, given_name: nil, intercom: nil, locale: nil, middle_name: nil, ms_teams: nil, name: nil, nickname: nil, phone_number: nil, phone_number_verified: nil, picture: nil, preferred_name: nil, profile: nil, slack: nil, sub: nil, target_arn: nil, updated_at: nil, website: nil, zoneinfo: nil)
+      # @!method initialize(address: nil, airship: nil, apn: nil, aws_sns: nil, birthdate: nil, custom: nil, discord: nil, email: nil, email_verified: nil, expo: nil, facebook_psid: nil, family_name: nil, firebase_token: nil, gender: nil, given_name: nil, intercom: nil, locale: nil, middle_name: nil, ms_teams: nil, name: nil, nickname: nil, phone_number: nil, phone_number_verified: nil, picture: nil, preferred_name: nil, profile: nil, slack: nil, sub: nil, updated_at: nil, website: nil, zoneinfo: nil)
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::UserProfile} for more details.
       #
@@ -173,6 +176,8 @@ module Courier
       #
       #   @param apn [String, nil]
       #
+      #   @param aws_sns [Courier::Models::AwsSns, nil] Routes a push notification through the AWS SNS provider. The target ARN must be
+      #
       #   @param birthdate [String, nil]
       #
       #   @param custom [Hash{Symbol=>Object}, nil] A free form object. Due to a limitation of the API Explorer, you can only enter
@@ -221,8 +226,6 @@ module Courier
       #
       #   @param sub [String, nil]
       #
-      #   @param target_arn [String, nil]
-      #
       #   @param updated_at [String, nil]
       #
       #   @param website [String, nil]

data/lib/courier/models.rb

@@ -83,6 +83,8 @@ module Courier
 
   AutomationTemplateListResponse = Courier::Models::AutomationTemplateListResponse
 
+  AwsSns = Courier::Models::AwsSns
+
   BaseCheck = Courier::Models::BaseCheck
 
   BaseTemplateTenantAssociation = Courier::Models::BaseTemplateTenantAssociation

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.26.2"
+  VERSION = "5.0.0"
 end

data/lib/courier.rb

@@ -116,6 +116,7 @@ require_relative "courier/models/automations/invoke_invoke_ad_hoc_params"
 require_relative "courier/models/automations/invoke_invoke_by_template_params"
 require_relative "courier/models/automation_template"
 require_relative "courier/models/automation_template_list_response"
+require_relative "courier/models/aws_sns"
 require_relative "courier/models/brand"
 require_relative "courier/models/brand_colors"
 require_relative "courier/models/brand_create_params"

data/rbi/courier/models/aws_sns.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class AwsSns < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::AwsSns, Courier::Internal::AnyHash) }
+
+      # The ARN of the SNS platform endpoint, topic, or application to publish to.
+      sig { returns(String) }
+      attr_accessor :target_arn
+
+      # Routes a push notification through the AWS SNS provider. The target ARN must be
+      # nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
+      # the provider.
+      sig { params(target_arn: String).returns(T.attached_class) }
+      def self.new(
+        # The ARN of the SNS platform endpoint, topic, or application to publish to.
+        target_arn:
+      )
+      end
+
+      sig { override.returns({ target_arn: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/user_profile.rbi

@@ -23,6 +23,15 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :apn
 
+      # Routes a push notification through the AWS SNS provider. The target ARN must be
+      # nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
+      # the provider.
+      sig { returns(T.nilable(Courier::AwsSns)) }
+      attr_reader :aws_sns
+
+      sig { params(aws_sns: T.nilable(Courier::AwsSns::OrHash)).void }
+      attr_writer :aws_sns
+
       sig { returns(T.nilable(String)) }
       attr_accessor :birthdate
 
@@ -126,9 +135,6 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :sub
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :target_arn
-
       sig { returns(T.nilable(String)) }
       attr_accessor :updated_at
 
@@ -143,6 +149,7 @@ module Courier
           address: T.nilable(Courier::UserProfile::Address::OrHash),
           airship: T.nilable(Courier::AirshipProfile::OrHash),
           apn: T.nilable(String),
+          aws_sns: T.nilable(Courier::AwsSns::OrHash),
           birthdate: T.nilable(String),
           custom: T.nilable(T::Hash[Symbol, T.anything]),
           discord:
@@ -193,7 +200,6 @@ module Courier
               )
             ),
           sub: T.nilable(String),
-          target_arn: T.nilable(String),
           updated_at: T.nilable(String),
           website: T.nilable(String),
           zoneinfo: T.nilable(String)
@@ -203,6 +209,10 @@ module Courier
         address: nil,
         airship: nil,
         apn: nil,
+        # Routes a push notification through the AWS SNS provider. The target ARN must be
+        # nested under `aws_sns` — a top-level `target_arn` on the profile is ignored by
+        # the provider.
+        aws_sns: nil,
         birthdate: nil,
         # A free form object. Due to a limitation of the API Explorer, you can only enter
         # string key/values below, but this API accepts more complex object structures.
@@ -229,7 +239,6 @@ module Courier
         profile: nil,
         slack: nil,
         sub: nil,
-        target_arn: nil,
         updated_at: nil,
         website: nil,
         zoneinfo: nil
@@ -242,6 +251,7 @@ module Courier
             address: T.nilable(Courier::UserProfile::Address),
             airship: T.nilable(Courier::AirshipProfile),
             apn: T.nilable(String),
+            aws_sns: T.nilable(Courier::AwsSns),
             birthdate: T.nilable(String),
             custom: T.nilable(T::Hash[Symbol, T.anything]),
             discord:
@@ -286,7 +296,6 @@ module Courier
                 )
               ),
             sub: T.nilable(String),
-            target_arn: T.nilable(String),
             updated_at: T.nilable(String),
             website: T.nilable(String),
             zoneinfo: T.nilable(String)

data/rbi/courier/models.rbi

@@ -47,6 +47,8 @@ module Courier
   AutomationTemplateListResponse =
     Courier::Models::AutomationTemplateListResponse
 
+  AwsSns = Courier::Models::AwsSns
+
   BaseCheck = Courier::Models::BaseCheck
 
   BaseTemplateTenantAssociation = Courier::Models::BaseTemplateTenantAssociation

data/sig/courier/models/aws_sns.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type aws_sns = { target_arn: String }
+
+    class AwsSns < Courier::Internal::Type::BaseModel
+      attr_accessor target_arn: String
+
+      def initialize: (target_arn: String) -> void
+
+      def to_hash: -> { target_arn: String }
+    end
+  end
+end

data/sig/courier/models/user_profile.rbs

@@ -5,6 +5,7 @@ module Courier
         address: Courier::UserProfile::Address?,
         airship: Courier::AirshipProfile?,
         apn: String?,
+        aws_sns: Courier::AwsSns?,
         birthdate: String?,
         custom: ::Hash[Symbol, top]?,
         discord: Courier::Models::discord?,
@@ -29,7 +30,6 @@ module Courier
         profile: String?,
         slack: Courier::Models::slack?,
         sub: String?,
-        target_arn: String?,
         updated_at: String?,
         website: String?,
         zoneinfo: String?
@@ -42,6 +42,8 @@ module Courier
 
       attr_accessor apn: String?
 
+      attr_accessor aws_sns: Courier::AwsSns?
+
       attr_accessor birthdate: String?
 
       attr_accessor custom: ::Hash[Symbol, top]?
@@ -90,8 +92,6 @@ module Courier
 
       attr_accessor sub: String?
 
-      attr_accessor target_arn: String?
-
       attr_accessor updated_at: String?
 
       attr_accessor website: String?
@@ -102,6 +102,7 @@ module Courier
         ?address: Courier::UserProfile::Address?,
         ?airship: Courier::AirshipProfile?,
         ?apn: String?,
+        ?aws_sns: Courier::AwsSns?,
         ?birthdate: String?,
         ?custom: ::Hash[Symbol, top]?,
         ?discord: Courier::Models::discord?,
@@ -126,7 +127,6 @@ module Courier
         ?profile: String?,
         ?slack: Courier::Models::slack?,
         ?sub: String?,
-        ?target_arn: String?,
         ?updated_at: String?,
         ?website: String?,
         ?zoneinfo: String?
@@ -136,6 +136,7 @@ module Courier
         address: Courier::UserProfile::Address?,
         airship: Courier::AirshipProfile?,
         apn: String?,
+        aws_sns: Courier::AwsSns?,
         birthdate: String?,
         custom: ::Hash[Symbol, top]?,
         discord: Courier::Models::discord?,
@@ -160,7 +161,6 @@ module Courier
         profile: String?,
         slack: Courier::Models::slack?,
         sub: String?,
-        target_arn: String?,
         updated_at: String?,
         website: String?,
         zoneinfo: String?

data/sig/courier/models.rbs

@@ -43,6 +43,8 @@ module Courier
 
   class AutomationTemplateListResponse = Courier::Models::AutomationTemplateListResponse
 
+  class AwsSns = Courier::Models::AwsSns
+
   class BaseCheck = Courier::Models::BaseCheck
 
   class BaseTemplateTenantAssociation = Courier::Models::BaseTemplateTenantAssociation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 4.26.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Courier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-14 00:00:00.000000000 Z
+date: 2026-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -97,6 +97,7 @@ files:
 - lib/courier/models/automation_template_list_response.rb
 - lib/courier/models/automations/invoke_invoke_ad_hoc_params.rb
 - lib/courier/models/automations/invoke_invoke_by_template_params.rb
+- lib/courier/models/aws_sns.rb
 - lib/courier/models/base_check.rb
 - lib/courier/models/base_template_tenant_association.rb
 - lib/courier/models/brand.rb
@@ -548,6 +549,7 @@ files:
 - rbi/courier/models/automation_template_list_response.rbi
 - rbi/courier/models/automations/invoke_invoke_ad_hoc_params.rbi
 - rbi/courier/models/automations/invoke_invoke_by_template_params.rbi
+- rbi/courier/models/aws_sns.rbi
 - rbi/courier/models/base_check.rbi
 - rbi/courier/models/base_template_tenant_association.rbi
 - rbi/courier/models/brand.rbi
@@ -998,6 +1000,7 @@ files:
 - sig/courier/models/automation_template_list_response.rbs
 - sig/courier/models/automations/invoke_invoke_ad_hoc_params.rbs
 - sig/courier/models/automations/invoke_invoke_by_template_params.rbs
+- sig/courier/models/aws_sns.rbs
 - sig/courier/models/base_check.rbs
 - sig/courier/models/base_template_tenant_association.rbs
 - sig/courier/models/brand.rbs