trycourier 4.9.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3402c91918996a99ee5f6847167c87f49ca1d0a711da6de88c1ab620ea1ca58c
-  data.tar.gz: cc72a6efa7d4c23d88069a482f153da899680bcebc0a418e85361e759441fe52
+  metadata.gz: d71ef55224ae3a498561c16171a3a2f4d7043cdd17d9c505ef34e70179a6c35b
+  data.tar.gz: da26b63925075f65d3d953a4a810ea535431e65274528b902000121d928c7fcb
 SHA512:
-  metadata.gz: bea7a9fa2457eca3c876aa38a6bbb492fec8f965b06e4b2e1a8ae3df10454cfe08aa04536546e392a36c03341a54bf7103a8444c6de9dd97c1cdc35abba942f6
-  data.tar.gz: 10913c571258c67c3ce10362794e30d2a742b117cde9f4ddbe02a8eabf7c568be4bb64871169ece92b2fe443a3480471adab6c506ac41b7a172579740827b3a0
+  metadata.gz: 237604be72c50aa572c525addf58d4e3f723142ffbd5863c9dfb301882bf9efa4c77e4eae7a143cafc3ed1981fb0602be0bb7a1046d4be8e5587c2c15988fd52
+  data.tar.gz: cfdb4b9bcf90da1d34e9aabbe994404f49e6df75d4d56368509034b60ceb55eb0461d492cbaf2d2cb7a4b92e17f54a6050f7b605a0f2c00a8b9788c6142255d1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** add list_notifications method to routing_strategies ([ce8f121](https://github.com/trycourier/courier-ruby/commit/ce8f1217d52377144e053e51497310e71fef1dea))
+* **api:** add put_content/put_element/put_locale, remove draft resource, update retrieve_content ([ecb21e4](https://github.com/trycourier/courier-ruby/commit/ecb21e4913ec80513471153abab2e75d80afffb5))
+
 ## 4.9.0 (2026-04-01)
 
 Full Changelog: [v4.8.0...v4.9.0](https://github.com/trycourier/courier-ruby/compare/v4.8.0...v4.9.0)

data/lib/courier/models/associated_notification_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#list_notifications
+    class AssociatedNotificationListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::NotificationTemplateSummary>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::NotificationTemplateSummary] }
+
+      # @!method initialize(paging:, results:)
+      #   Paginated list of notification templates associated with a routing strategy.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::NotificationTemplateSummary>]
+    end
+  end
+end

data/lib/courier/models/element_with_checksums.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ElementWithChecksums < Courier::Internal::Type::BaseModel
+      # @!attribute checksum
+      #   MD5 hash of translatable content.
+      #
+      #   @return [String]
+      required :checksum, String
+
+      # @!attribute type
+      #   Element type (text, meta, action, etc.).
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute elements
+      #   Nested child elements (for group-type elements).
+      #
+      #   @return [Array<Courier::Models::ElementWithChecksums>, nil]
+      optional :elements, -> { Courier::Internal::Type::ArrayOf[Courier::ElementWithChecksums] }
+
+      # @!attribute locales
+      #   Locale-specific content with checksums.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::ElementWithChecksums::Locale}, nil]
+      optional :locales, -> { Courier::Internal::Type::HashOf[Courier::ElementWithChecksums::Locale] }
+
+      # @!method initialize(checksum:, type:, id: nil, elements: nil, locales: nil)
+      #   An element with its content checksum and optional nested elements and locale
+      #   checksums.
+      #
+      #   @param checksum [String] MD5 hash of translatable content.
+      #
+      #   @param type [String] Element type (text, meta, action, etc.).
+      #
+      #   @param id [String]
+      #
+      #   @param elements [Array<Courier::Models::ElementWithChecksums>] Nested child elements (for group-type elements).
+      #
+      #   @param locales [Hash{Symbol=>Courier::Models::ElementWithChecksums::Locale}] Locale-specific content with checksums.
+
+      class Locale < Courier::Internal::Type::BaseModel
+        # @!attribute checksum
+        #
+        #   @return [String]
+        required :checksum, String
+
+        # @!method initialize(checksum:)
+        #   @param checksum [String]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_content_get_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationContentGetResponse < Courier::Internal::Type::BaseModel
+      # @!attribute elements
+      #
+      #   @return [Array<Courier::Models::ElementWithChecksums>]
+      required :elements, -> { Courier::Internal::Type::ArrayOf[Courier::ElementWithChecksums] }
+
+      # @!attribute version
+      #   Content version identifier.
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(elements:, version:)
+      #   Elemental content response for V2 templates. Contains versioned elements with
+      #   content checksums.
+      #
+      #   @param elements [Array<Courier::Models::ElementWithChecksums>]
+      #
+      #   @param version [String] Content version identifier.
+    end
+  end
+end

data/lib/courier/models/notification_content_mutation_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_content
+    class NotificationContentMutationResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   Template ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute elements
+      #
+      #   @return [Array<Courier::Models::NotificationContentMutationResponse::Element>]
+      required :elements,
+               -> { Courier::Internal::Type::ArrayOf[Courier::NotificationContentMutationResponse::Element] }
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState]
+      required :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!attribute version
+      #   Content version identifier.
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(id:, elements:, state:, version:)
+      #   Shared mutation response for `PUT` content, `PUT` element, and `PUT` locale
+      #   operations. Contains the template ID, content version, per-element checksums,
+      #   and resulting state.
+      #
+      #   @param id [String] Template ID.
+      #
+      #   @param elements [Array<Courier::Models::NotificationContentMutationResponse::Element>]
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+      #
+      #   @param version [String] Content version identifier.
+
+      class Element < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute checksum
+        #
+        #   @return [String]
+        required :checksum, String
+
+        # @!method initialize(id:, checksum:)
+        #   @param id [String]
+        #   @param checksum [String]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_content_put_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationContentPutRequest < Courier::Internal::Type::BaseModel
+      # @!attribute content
+      #   Elemental content payload. The server defaults `version` when omitted.
+      #
+      #   @return [Courier::Models::NotificationContentPutRequest::Content]
+      required :content, -> { Courier::NotificationContentPutRequest::Content }
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!method initialize(content:, state: nil)
+      #   Request body for replacing the elemental content of a notification template.
+      #
+      #   @param content [Courier::Models::NotificationContentPutRequest::Content] Elemental content payload. The server defaults `version` when omitted.
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+
+      # @see Courier::Models::NotificationContentPutRequest#content
+      class Content < Courier::Internal::Type::BaseModel
+        # @!attribute elements
+        #
+        #   @return [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+        required :elements, -> { Courier::Internal::Type::ArrayOf[union: Courier::ElementalNode] }
+
+        # @!attribute version
+        #   Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+        #   omitted.
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(elements:, version: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::NotificationContentPutRequest::Content} for more details.
+        #
+        #   Elemental content payload. The server defaults `version` when omitted.
+        #
+        #   @param elements [Array<Courier::Models::ElementalTextNodeWithType, Courier::Models::ElementalMetaNodeWithType, Courier::Models::ElementalChannelNodeWithType, Courier::Models::ElementalImageNodeWithType, Courier::Models::ElementalActionNodeWithType, Courier::Models::ElementalDividerNodeWithType, Courier::Models::ElementalQuoteNodeWithType, Courier::Models::ElementalHTMLNodeWithType>]
+        #
+        #   @param version [String] Content version identifier (e.g., `2022-01-01`). Optional; server defaults when
+      end
+    end
+  end
+end

data/lib/courier/models/notification_element_put_request.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationElementPutRequest < Courier::Internal::Type::BaseModel
+      # @!attribute type
+      #   Element type (text, meta, action, image, etc.).
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute channels
+      #
+      #   @return [Array<String>, nil]
+      optional :channels, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute if_
+      #
+      #   @return [String, nil]
+      optional :if_, String, api_name: :if
+
+      # @!attribute loop_
+      #
+      #   @return [String, nil]
+      optional :loop_, String, api_name: :loop
+
+      # @!attribute ref
+      #
+      #   @return [String, nil]
+      optional :ref, String
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!method initialize(type:, channels: nil, data: nil, if_: nil, loop_: nil, ref: nil, state: nil)
+      #   Request body for updating a single element. Additional type-specific fields are
+      #   allowed.
+      #
+      #   @param type [String] Element type (text, meta, action, image, etc.).
+      #
+      #   @param channels [Array<String>]
+      #
+      #   @param data [Hash{Symbol=>Object}]
+      #
+      #   @param if_ [String]
+      #
+      #   @param loop_ [String]
+      #
+      #   @param ref [String]
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+    end
+  end
+end

data/lib/courier/models/notification_get_content.rb

@@ -2,7 +2,6 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::Notifications#retrieve_content
     class NotificationGetContent < Courier::Internal::Type::BaseModel
       # @!attribute blocks
       #

data/lib/courier/models/notification_locale_put_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationLocalePutRequest < Courier::Internal::Type::BaseModel
+      # @!attribute elements
+      #   Elements with locale-specific content overrides.
+      #
+      #   @return [Array<Courier::Models::NotificationLocalePutRequest::Element>]
+      required :elements,
+               -> { Courier::Internal::Type::ArrayOf[Courier::NotificationLocalePutRequest::Element] }
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!method initialize(elements:, state: nil)
+      #   Request body for setting locale-specific content overrides. Each element
+      #   override must include the target element ID.
+      #
+      #   @param elements [Array<Courier::Models::NotificationLocalePutRequest::Element>] Elements with locale-specific content overrides.
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+
+      class Element < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #   Target element ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   @param id [String] Target element ID.
+      end
+    end
+  end
+end

data/lib/courier/models/notification_put_content_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_content
+    class NotificationPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_put_element_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_element
+    class NotificationPutElementParams < Courier::Models::NotificationElementPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute element_id
+      #
+      #   @return [String]
+      required :element_id, String
+
+      # @!method initialize(id:, element_id:, request_options: {})
+      #   @param id [String]
+      #   @param element_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_put_locale_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_locale
+    class NotificationPutLocaleParams < Courier::Models::NotificationLocalePutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute locale_id
+      #
+      #   @return [String]
+      required :locale_id, String
+
+      # @!method initialize(id:, locale_id:, request_options: {})
+      #   @param id [String]
+      #   @param locale_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_retrieve_content_params.rb

@@ -12,8 +12,21 @@ module Courier
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute version
+      #   Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+      #   `published`.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(id:, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationRetrieveContentParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param version [String] Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to `p
+      #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/notification_retrieve_content_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Elemental content response for V2 templates. Contains versioned elements with
+    # content checksums.
+    #
+    # @see Courier::Resources::Notifications#retrieve_content
+    module NotificationRetrieveContentResponse
+      extend Courier::Internal::Type::Union
+
+      # Elemental content response for V2 templates. Contains versioned elements with content checksums.
+      variant -> { Courier::NotificationContentGetResponse }
+
+      variant -> { Courier::NotificationGetContent }
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::NotificationContentGetResponse, Courier::Models::NotificationGetContent)]
+    end
+  end
+end

data/lib/courier/models/notification_template_state.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Template state. Defaults to `DRAFT`.
+    module NotificationTemplateState
+      extend Courier::Internal::Type::Enum
+
+      DRAFT = :DRAFT
+      PUBLISHED = :PUBLISHED
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_list_notifications_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#list_notifications
+    class RoutingStrategyListNotificationsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute limit
+      #   Maximum number of results per page. Default 20, max 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @param limit [Integer] Maximum number of results per page. Default 20, max 100.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models.rb

@@ -45,6 +45,8 @@ module Courier
 
   Alignment = Courier::Models::Alignment
 
+  AssociatedNotificationListResponse = Courier::Models::AssociatedNotificationListResponse
+
   Audience = Courier::Models::Audience
 
   AudienceDeleteParams = Courier::Models::AudienceDeleteParams
@@ -163,6 +165,8 @@ module Courier
 
   ElementalTextNodeWithType = Courier::Models::ElementalTextNodeWithType
 
+  ElementWithChecksums = Courier::Models::ElementWithChecksums
+
   EmailFooter = Courier::Models::EmailFooter
 
   EmailHead = Courier::Models::EmailHead
@@ -255,18 +259,34 @@ module Courier
 
   NotificationArchiveParams = Courier::Models::NotificationArchiveParams
 
+  NotificationContentGetResponse = Courier::Models::NotificationContentGetResponse
+
+  NotificationContentMutationResponse = Courier::Models::NotificationContentMutationResponse
+
+  NotificationContentPutRequest = Courier::Models::NotificationContentPutRequest
+
   NotificationCreateParams = Courier::Models::NotificationCreateParams
 
+  NotificationElementPutRequest = Courier::Models::NotificationElementPutRequest
+
   NotificationGetContent = Courier::Models::NotificationGetContent
 
   NotificationListParams = Courier::Models::NotificationListParams
 
   NotificationListVersionsParams = Courier::Models::NotificationListVersionsParams
 
+  NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
   NotificationPublishParams = Courier::Models::NotificationPublishParams
 
+  NotificationPutContentParams = Courier::Models::NotificationPutContentParams
+
+  NotificationPutElementParams = Courier::Models::NotificationPutElementParams
+
+  NotificationPutLocaleParams = Courier::Models::NotificationPutLocaleParams
+
   NotificationReplaceParams = Courier::Models::NotificationReplaceParams
 
   NotificationRetrieveContentParams = Courier::Models::NotificationRetrieveContentParams
@@ -285,6 +305,8 @@ module Courier
 
   NotificationTemplatePublishRequest = Courier::Models::NotificationTemplatePublishRequest
 
+  NotificationTemplateState = Courier::Models::NotificationTemplateState
+
   NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
 
   NotificationTemplateUpdateRequest = Courier::Models::NotificationTemplateUpdateRequest
@@ -351,6 +373,8 @@ module Courier
 
   RoutingStrategyGetResponse = Courier::Models::RoutingStrategyGetResponse
 
+  RoutingStrategyListNotificationsParams = Courier::Models::RoutingStrategyListNotificationsParams
+
   RoutingStrategyListParams = Courier::Models::RoutingStrategyListParams
 
   RoutingStrategyListResponse = Courier::Models::RoutingStrategyListResponse