trycourier 4.10.0 → 4.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d71ef55224ae3a498561c16171a3a2f4d7043cdd17d9c505ef34e70179a6c35b
-  data.tar.gz: da26b63925075f65d3d953a4a810ea535431e65274528b902000121d928c7fcb
+  metadata.gz: 2c653d07cd54be88e8b8328788188c56e6d62e7308f6bccf582769bd38b5e413
+  data.tar.gz: 9a025d1497b0e9383686ba5c849d2784be1195c7c21a52ba24d2491f6e5ebe71
 SHA512:
-  metadata.gz: 237604be72c50aa572c525addf58d4e3f723142ffbd5863c9dfb301882bf9efa4c77e4eae7a143cafc3ed1981fb0602be0bb7a1046d4be8e5587c2c15988fd52
-  data.tar.gz: cfdb4b9bcf90da1d34e9aabbe994404f49e6df75d4d56368509034b60ceb55eb0461d492cbaf2d2cb7a4b92e17f54a6050f7b605a0f2c00a8b9788c6142255d1
+  metadata.gz: ee312a1f98ddfd71c03692e23047237cd1205465687890e3d0dea3bd675acb6ed1ba30b340e67a85e9cd3d73017c09c29e5ef0a3946c4b6e2ccb806e7af29392
+  data.tar.gz: ac1e5417c4e7400965fc5efc5074e40cff4e5e4b5a4427795884cdba02869dbc54185252d2653c9599fe745b8a78e2fd0793675bf9a08b6a9d5d3903ee0139c8

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 4.10.2 (2026-04-14)
+
+Full Changelog: [v4.10.1...v4.10.2](https://github.com/trycourier/courier-ruby/compare/v4.10.1...v4.10.2)
+
+### Bug Fixes
+
+* **types:** flatten NotificationTemplateResponse model structure ([4c019eb](https://github.com/trycourier/courier-ruby/commit/4c019ebb34aaf3b6c37e778da95c593aa5faa409))
+* **types:** make note optional, flatten NotificationTemplateGetResponse ([05f8c8c](https://github.com/trycourier/courier-ruby/commit/05f8c8c41198a2f8156ac10ccf4a67fa84130350))
+
+## 4.10.1 (2026-04-13)
+
+Full Changelog: [v4.10.0...v4.10.1](https://github.com/trycourier/courier-ruby/compare/v4.10.0...v4.10.1)
+
+### Bug Fixes
+
+* multipart encoding for file arrays ([6f54534](https://github.com/trycourier/courier-ruby/commit/6f545347ec738929c45b89476d4fc02aa185760b))
+* **types:** correct notifications/routing_strategies return types, remove mutation models ([8020a8f](https://github.com/trycourier/courier-ruby/commit/8020a8fa2015d5f5b4c4703a4354acd3283193bc))
+
 ## 4.10.0 (2026-04-08)
 
 Full Changelog: [v4.9.0...v4.10.0](https://github.com/trycourier/courier-ruby/compare/v4.9.0...v4.10.0)

data/lib/courier/internal/util.rb

@@ -610,6 +610,7 @@ module Courier
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -619,7 +620,7 @@ module Courier
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Courier::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -635,6 +636,7 @@ module Courier
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/courier/models/notification_list_response.rb

@@ -47,11 +47,6 @@ module Courier
           #   @return [Array<String>]
           required :event_ids, Courier::Internal::Type::ArrayOf[String]
 
-          # @!attribute note
-          #
-          #   @return [String]
-          required :note, String
-
           # @!attribute routing
           #
           #   @return [Courier::Models::MessageRouting]
@@ -67,6 +62,11 @@ module Courier
           #   @return [Integer]
           required :updated_at, Integer
 
+          # @!attribute note
+          #
+          #   @return [String, nil]
+          optional :note, String
+
           # @!attribute tags
           #
           #   @return [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
@@ -77,21 +77,21 @@ module Courier
           #   @return [String, nil]
           optional :title, String, nil?: true
 
-          # @!method initialize(id:, created_at:, event_ids:, note:, routing:, topic_id:, updated_at:, tags: nil, title: nil)
+          # @!method initialize(id:, created_at:, event_ids:, routing:, topic_id:, updated_at:, note: nil, tags: nil, title: nil)
           #   @param id [String]
           #
           #   @param created_at [Integer]
           #
           #   @param event_ids [Array<String>] Array of event IDs associated with this notification
           #
-          #   @param note [String]
-          #
           #   @param routing [Courier::Models::MessageRouting]
           #
           #   @param topic_id [String]
           #
           #   @param updated_at [Integer]
           #
+          #   @param note [String]
+          #
           #   @param tags [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
           #
           #   @param title [String, nil]

data/lib/courier/models/notification_template_create_request.rb

@@ -4,8 +4,8 @@ module Courier
   module Models
     class NotificationTemplateCreateRequest < Courier::Internal::Type::BaseModel
       # @!attribute notification
-      #   Full document shape used in POST and PUT request bodies, and returned inside the
-      #   GET response envelope.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @return [Courier::Models::NotificationTemplatePayload]
       required :notification, -> { Courier::NotificationTemplatePayload }
@@ -23,7 +23,7 @@ module Courier
       #
       #   Request body for creating a notification template.
       #
-      #   @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #   @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       #   @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
 

data/lib/courier/models/notification_template_payload.rb

@@ -40,8 +40,8 @@ module Courier
       required :tags, Courier::Internal::Type::ArrayOf[String]
 
       # @!method initialize(brand:, content:, name:, routing:, subscription:, tags:)
-      #   Full document shape used in POST and PUT request bodies, and returned inside the
-      #   GET response envelope.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @param brand [Courier::Models::NotificationTemplatePayload::Brand, nil] Brand reference, or null for no brand.
       #

data/lib/courier/models/notification_template_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#create
+    class NotificationTemplateResponse < Courier::Models::NotificationTemplatePayload
+      # @!attribute id
+      #   The template ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Epoch milliseconds when the template was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute state
+      #   The template state. Always uppercase.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateResponse::State]
+      required :state, enum: -> { Courier::NotificationTemplateResponse::State }
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String
+
+      # @!method initialize(id:, created:, creator:, state:, updated: nil, updater: nil)
+      #   Response for GET /notifications/{id}, POST /notifications, and PUT
+      #   /notifications/{id}. Returns all template fields at the top level.
+      #
+      #   @param id [String] The template ID.
+      #
+      #   @param created [Integer] Epoch milliseconds when the template was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateResponse::State] The template state. Always uppercase.
+      #
+      #   @param updated [Integer] Epoch milliseconds of last update.
+      #
+      #   @param updater [String] User ID of the last updater.
+
+      # The template state. Always uppercase.
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_update_request.rb

@@ -4,8 +4,8 @@ module Courier
   module Models
     class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
       # @!attribute notification
-      #   Full document shape used in POST and PUT request bodies, and returned inside the
-      #   GET response envelope.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @return [Courier::Models::NotificationTemplatePayload]
       required :notification, -> { Courier::NotificationTemplatePayload }
@@ -24,7 +24,7 @@ module Courier
       #   Request body for replacing a notification template. Same shape as create. All
       #   fields required (PUT = full replacement).
       #
-      #   @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #   @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       #   @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
 

data/lib/courier/models/provider_update_params.rb

@@ -13,7 +13,8 @@ module Courier
       required :id, String
 
       # @!attribute provider
-      #   The provider key identifying the type.
+      #   The provider key identifying the type. Required on every request because it
+      #   selects the provider-specific settings schema for validation.
       #
       #   @return [String]
       required :provider, String
@@ -44,7 +45,7 @@ module Courier
       #
       #   @param id [String]
       #
-      #   @param provider [String] The provider key identifying the type.
+      #   @param provider [String] The provider key identifying the type. Required on every request because it sele
       #
       #   @param alias_ [String] Updated alias. Omit to clear.
       #

data/lib/courier/models/routing_strategy_get_response.rb

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::RoutingStrategies#retrieve
+    # @see Courier::Resources::RoutingStrategies#create
     class RoutingStrategyGetResponse < Courier::Internal::Type::BaseModel
       # @!attribute id
       #   The routing strategy ID (rs\_ prefix).

data/lib/courier/models.rb

@@ -297,14 +297,12 @@ module Courier
 
   NotificationTemplateCreateRequest = Courier::Models::NotificationTemplateCreateRequest
 
-  NotificationTemplateGetResponse = Courier::Models::NotificationTemplateGetResponse
-
-  NotificationTemplateMutationResponse = Courier::Models::NotificationTemplateMutationResponse
-
   NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
 
   NotificationTemplatePublishRequest = Courier::Models::NotificationTemplatePublishRequest
 
+  NotificationTemplateResponse = Courier::Models::NotificationTemplateResponse
+
   NotificationTemplateState = Courier::Models::NotificationTemplateState
 
   NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
@@ -379,8 +377,6 @@ module Courier
 
   RoutingStrategyListResponse = Courier::Models::RoutingStrategyListResponse
 
-  RoutingStrategyMutationResponse = Courier::Models::RoutingStrategyMutationResponse
-
   RoutingStrategyReplaceParams = Courier::Models::RoutingStrategyReplaceParams
 
   RoutingStrategyReplaceRequest = Courier::Models::RoutingStrategyReplaceRequest

data/lib/courier/resources/notifications/checks.rb

@@ -4,11 +4,13 @@ module Courier
   module Resources
     class Notifications
       class Checks
+        # Replace the checks for a notification template submission.
+        #
         # @overload update(submission_id, id:, checks:, request_options: {})
         #
-        # @param submission_id [String] Path param
+        # @param submission_id [String] Path param: Submission ID.
         #
-        # @param id [String] Path param
+        # @param id [String] Path param: Notification template ID.
         #
         # @param checks [Array<Courier::Models::BaseCheck>] Body param
         #
@@ -32,10 +34,14 @@ module Courier
           )
         end
 
+        # Retrieve the checks for a notification template submission.
+        #
         # @overload list(submission_id, id:, request_options: {})
         #
-        # @param submission_id [String]
-        # @param id [String]
+        # @param submission_id [String] Submission ID.
+        #
+        # @param id [String] Notification template ID.
+        #
         # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Courier::Models::Notifications::CheckListResponse]
@@ -55,10 +61,14 @@ module Courier
           )
         end
 
+        # Cancel a notification template submission.
+        #
         # @overload delete(submission_id, id:, request_options: {})
         #
-        # @param submission_id [String]
-        # @param id [String]
+        # @param submission_id [String] Submission ID.
+        #
+        # @param id [String] Notification template ID.
+        #
         # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]

data/lib/courier/resources/notifications.rb

@@ -14,13 +14,13 @@ module Courier
       #
       # @overload create(notification:, state: nil, request_options: {})
       #
-      # @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      # @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       # @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::NotificationTemplateMutationResponse]
+      # @return [Courier::Models::NotificationTemplateResponse]
       #
       # @see Courier::Models::NotificationCreateParams
       def create(params)
@@ -29,7 +29,7 @@ module Courier
           method: :post,
           path: "notifications",
           body: parsed,
-          model: Courier::NotificationTemplateMutationResponse,
+          model: Courier::NotificationTemplateResponse,
           options: options
         )
       end
@@ -48,7 +48,7 @@ module Courier
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::NotificationTemplateGetResponse]
+      # @return [Courier::Models::NotificationTemplateResponse]
       #
       # @see Courier::Models::NotificationRetrieveParams
       def retrieve(id, params = {})
@@ -58,7 +58,7 @@ module Courier
           method: :get,
           path: ["notifications/%1$s", id],
           query: query,
-          model: Courier::NotificationTemplateGetResponse,
+          model: Courier::NotificationTemplateResponse,
           options: options
         )
       end
@@ -276,13 +276,13 @@ module Courier
       #
       # @param id [String] Template ID (nt\_ prefix).
       #
-      # @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      # @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       # @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::NotificationTemplateMutationResponse]
+      # @return [Courier::Models::NotificationTemplateResponse]
       #
       # @see Courier::Models::NotificationReplaceParams
       def replace(id, params)
@@ -291,7 +291,7 @@ module Courier
           method: :put,
           path: ["notifications/%1$s", id],
           body: parsed,
-          model: Courier::NotificationTemplateMutationResponse,
+          model: Courier::NotificationTemplateResponse,
           options: options
         )
       end

data/lib/courier/resources/providers.rb

@@ -61,15 +61,17 @@ module Courier
       # Some parameter documentations has been truncated, see
       # {Courier::Models::ProviderUpdateParams} for more details.
       #
-      # Update an existing provider configuration. The `provider` key is required. All
-      # other fields are optional — omitted fields are cleared from the stored
-      # configuration (this is a full replacement, not a partial merge).
+      # Replace an existing provider configuration. The `provider` key is required and
+      # determines which provider-specific settings schema is applied. All other fields
+      # are optional — omitted fields are cleared from the stored configuration (this is
+      # a full replacement, not a partial merge). Changing the provider type for an
+      # existing configuration is not supported.
       #
       # @overload update(id, provider:, alias_: nil, settings: nil, title: nil, request_options: {})
       #
       # @param id [String] A unique identifier of the provider configuration to update.
       #
-      # @param provider [String] The provider key identifying the type.
+      # @param provider [String] The provider key identifying the type. Required on every request because it sele
       #
       # @param alias_ [String] Updated alias. Omit to clear.
       #
@@ -85,7 +87,7 @@ module Courier
       def update(id, params)
         parsed, options = Courier::ProviderUpdateParams.dump_request(params)
         @client.request(
-          method: :post,
+          method: :put,
           path: ["providers/%1$s", id],
           body: parsed,
           model: Courier::Provider,

data/lib/courier/resources/routing_strategies.rb

@@ -22,7 +22,7 @@ module Courier
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::RoutingStrategyMutationResponse]
+      # @return [Courier::Models::RoutingStrategyGetResponse]
       #
       # @see Courier::Models::RoutingStrategyCreateParams
       def create(params)
@@ -31,7 +31,7 @@ module Courier
           method: :post,
           path: "routing-strategies",
           body: parsed,
-          model: Courier::RoutingStrategyMutationResponse,
+          model: Courier::RoutingStrategyGetResponse,
           options: options
         )
       end
@@ -154,7 +154,7 @@ module Courier
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::RoutingStrategyMutationResponse]
+      # @return [Courier::Models::RoutingStrategyGetResponse]
       #
       # @see Courier::Models::RoutingStrategyReplaceParams
       def replace(id, params)
@@ -163,7 +163,7 @@ module Courier
           method: :put,
           path: ["routing-strategies/%1$s", id],
           body: parsed,
-          model: Courier::RoutingStrategyMutationResponse,
+          model: Courier::RoutingStrategyGetResponse,
           options: options
         )
       end

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -216,8 +216,7 @@ require_relative "courier/models/notifications/check_list_params"
 require_relative "courier/models/notifications/check_list_response"
 require_relative "courier/models/notifications/check_update_params"
 require_relative "courier/models/notifications/check_update_response"
-require_relative "courier/models/notification_template_get_response"
-require_relative "courier/models/notification_template_mutation_response"
+require_relative "courier/models/notification_template_response"
 require_relative "courier/models/notification_template_state"
 require_relative "courier/models/notification_template_summary"
 require_relative "courier/models/notification_template_version_list_response"
@@ -261,7 +260,6 @@ require_relative "courier/models/routing_strategy_get_response"
 require_relative "courier/models/routing_strategy_list_notifications_params"
 require_relative "courier/models/routing_strategy_list_params"
 require_relative "courier/models/routing_strategy_list_response"
-require_relative "courier/models/routing_strategy_mutation_response"
 require_relative "courier/models/routing_strategy_replace_params"
 require_relative "courier/models/routing_strategy_retrieve_params"
 require_relative "courier/models/routing_strategy_summary"

data/rbi/courier/models/notification_list_response.rbi

@@ -89,9 +89,6 @@ module Courier
           sig { returns(T::Array[String]) }
           attr_accessor :event_ids
 
-          sig { returns(String) }
-          attr_accessor :note
-
           sig { returns(Courier::MessageRouting) }
           attr_reader :routing
 
@@ -104,6 +101,12 @@ module Courier
           sig { returns(Integer) }
           attr_accessor :updated_at
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :note
+
+          sig { params(note: String).void }
+          attr_writer :note
+
           sig do
             returns(
               T.nilable(
@@ -131,10 +134,10 @@ module Courier
               id: String,
               created_at: Integer,
               event_ids: T::Array[String],
-              note: String,
               routing: Courier::MessageRouting::OrHash,
               topic_id: String,
               updated_at: Integer,
+              note: String,
               tags:
                 T.nilable(
                   Courier::Models::NotificationListResponse::Result::Notification::Tags::OrHash
@@ -147,10 +150,10 @@ module Courier
             created_at:,
             # Array of event IDs associated with this notification
             event_ids:,
-            note:,
             routing:,
             topic_id:,
             updated_at:,
+            note: nil,
             tags: nil,
             title: nil
           )
@@ -162,10 +165,10 @@ module Courier
                 id: String,
                 created_at: Integer,
                 event_ids: T::Array[String],
-                note: String,
                 routing: Courier::MessageRouting,
                 topic_id: String,
                 updated_at: Integer,
+                note: String,
                 tags:
                   T.nilable(
                     Courier::Models::NotificationListResponse::Result::Notification::Tags

data/rbi/courier/models/notification_template_create_request.rbi

@@ -11,8 +11,8 @@ module Courier
           )
         end
 
-      # Full document shape used in POST and PUT request bodies, and returned inside the
-      # GET response envelope.
+      # Core template fields used in POST and PUT request bodies (nested under a
+      # `notification` key) and returned at the top level in responses.
       sig { returns(Courier::NotificationTemplatePayload) }
       attr_reader :notification
 
@@ -45,8 +45,8 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
-        # Full document shape used in POST and PUT request bodies, and returned inside the
-        # GET response envelope.
+        # Core template fields used in POST and PUT request bodies (nested under a
+        # `notification` key) and returned at the top level in responses.
         notification:,
         # Template state after creation. Case-insensitive input, normalized to uppercase
         # in the response. Defaults to "DRAFT".

data/rbi/courier/models/notification_template_payload.rbi

@@ -65,8 +65,8 @@ module Courier
       sig { returns(T::Array[String]) }
       attr_accessor :tags
 
-      # Full document shape used in POST and PUT request bodies, and returned inside the
-      # GET response envelope.
+      # Core template fields used in POST and PUT request bodies (nested under a
+      # `notification` key) and returned at the top level in responses.
       sig do
         params(
           brand: T.nilable(Courier::NotificationTemplatePayload::Brand::OrHash),