trycourier 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e902cf56c5a1bbfd1efeb490133b4cbbd036913b9565d146a4e2a61cf016561e
-  data.tar.gz: d8776360739874f39e33d8ce8a2161910808db4a0dbcc2062c8054ad6a840ee2
+  metadata.gz: 37aa19773ceb09212a579b95cece20b1d95e2d9c284986234c2982ab5c99dd29
+  data.tar.gz: b44f8bfc0a5af5fd6cbc74caa6c2129e2e3effeddb4c785bd8e5558fefbb1db2
 SHA512:
-  metadata.gz: 9e25bc1935feedf5a3779307ebd3405b64dd491ba0cec9d0df81b68d4f9707fc0b019979a3933e53e68715b419debed4ea7b9c8553312983ee495a95ef82ca5b
-  data.tar.gz: a611de89bb3b2907b6b3997a9b0815c9fd9e4558005046c77ed59eb05ccf21b1898a06856913c606767337b67f1296531e2e66212f6785fb0f002e0d839b13de
+  metadata.gz: 3bfd8cc5bd06c32e4840af2f2a30a1b9526606988d789ea40789023f0c33358f34a4b7be8832427e74141d8245c76beabea559e934b0c32773ac37dd50b512b6
+  data.tar.gz: 7449070ddd94cbf33a51a69b907b7b9f44b01db49f3e70e2682d3b9c9d1f2d3bbc18a6038c3e86395bc494a0938fb8069db6b9871001dafe60e4f200dd3fc36f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.13.0 (2026-06-12)
+
+Full Changelog: [v4.12.0...v4.13.0](https://github.com/trycourier/courier-ruby/compare/v4.12.0...v4.13.0)
+
+### Features
+
+* **digests:** document digest REST endpoints in OpenAPI spec ([6fdd4fc](https://github.com/trycourier/courier-ruby/commit/6fdd4fc94c104e0f3ca8905108a18eeafd9c5abc))
+
 ## 4.12.0 (2026-05-28)
 
 Full Changelog: [v4.11.0...v4.12.0](https://github.com/trycourier/courier-ruby/compare/v4.11.0...v4.12.0)

data/lib/courier/client.rb

@@ -45,6 +45,9 @@ module Courier
     # @return [Courier::Resources::Bulk]
     attr_reader :bulk
 
+    # @return [Courier::Resources::Digests]
+    attr_reader :digests
+
     # @return [Courier::Resources::Inbound]
     attr_reader :inbound
 
@@ -145,6 +148,7 @@ module Courier
       @journeys = Courier::Resources::Journeys.new(client: self)
       @brands = Courier::Resources::Brands.new(client: self)
       @bulk = Courier::Resources::Bulk.new(client: self)
+      @digests = Courier::Resources::Digests.new(client: self)
       @inbound = Courier::Resources::Inbound.new(client: self)
       @lists = Courier::Resources::Lists.new(client: self)
       @messages = Courier::Resources::Messages.new(client: self)

data/lib/courier/models/digest_category.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class DigestCategory < Courier::Internal::Type::BaseModel
+      # @!attribute category_key
+      #   The key that identifies the category within the digest.
+      #
+      #   @return [String]
+      required :category_key, String
+
+      # @!attribute retain
+      #   Which events to keep when the number of events exceeds the retention limit for
+      #   the category.
+      #
+      #   @return [Symbol, Courier::Models::DigestCategory::Retain]
+      required :retain, enum: -> { Courier::DigestCategory::Retain }
+
+      # @!attribute sort_key
+      #   The data key used to order events when `retain` is `highest` or `lowest`.
+      #
+      #   @return [String, nil]
+      optional :sort_key, String
+
+      # @!method initialize(category_key:, retain:, sort_key: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::DigestCategory} for more details.
+      #
+      #   @param category_key [String] The key that identifies the category within the digest.
+      #
+      #   @param retain [Symbol, Courier::Models::DigestCategory::Retain] Which events to keep when the number of events exceeds the retention limit for t
+      #
+      #   @param sort_key [String] The data key used to order events when `retain` is `highest` or `lowest`.
+
+      # Which events to keep when the number of events exceeds the retention limit for
+      # the category.
+      #
+      # @see Courier::Models::DigestCategory#retain
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        FIRST = :first
+        LAST = :last
+        HIGHEST = :highest
+        LOWEST = :lowest
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/digest_instance.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class DigestInstance < Courier::Internal::Type::BaseModel
+      # @!attribute digest_instance_id
+      #   A unique identifier for the digest instance.
+      #
+      #   @return [String]
+      required :digest_instance_id, String
+
+      # @!attribute event_count
+      #   The total number of events received for this instance.
+      #
+      #   @return [Integer]
+      required :event_count, Integer
+
+      # @!attribute status
+      #   The status of the digest instance. `IN_PROGRESS` instances are still
+      #   accumulating events; `COMPLETED` instances have been released.
+      #
+      #   @return [Symbol, Courier::Models::DigestInstance::Status]
+      required :status, enum: -> { Courier::DigestInstance::Status }
+
+      # @!attribute user_id
+      #   The ID of the user this digest instance belongs to.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute categories
+      #   The categories configured for the digest.
+      #
+      #   @return [Array<Courier::Models::DigestCategory>, nil]
+      optional :categories, -> { Courier::Internal::Type::ArrayOf[Courier::DigestCategory] }
+
+      # @!attribute category_key_counts
+      #   A map of category key to the number of events received for that category.
+      #
+      #   @return [Hash{Symbol=>Integer}, nil]
+      optional :category_key_counts, Courier::Internal::Type::HashOf[Integer]
+
+      # @!attribute created_at
+      #   An ISO 8601 timestamp of when the digest instance was created.
+      #
+      #   @return [String, nil]
+      optional :created_at, String
+
+      # @!attribute disabled
+      #   Whether the digest instance has been disabled.
+      #
+      #   @return [Boolean, nil]
+      optional :disabled, Courier::Internal::Type::Boolean
+
+      # @!attribute tenant_id
+      #   The ID of the tenant this digest instance belongs to, if any.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String, nil?: true
+
+      # @!method initialize(digest_instance_id:, event_count:, status:, user_id:, categories: nil, category_key_counts: nil, created_at: nil, disabled: nil, tenant_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::DigestInstance} for more details.
+      #
+      #   @param digest_instance_id [String] A unique identifier for the digest instance.
+      #
+      #   @param event_count [Integer] The total number of events received for this instance.
+      #
+      #   @param status [Symbol, Courier::Models::DigestInstance::Status] The status of the digest instance. `IN_PROGRESS` instances are still accumulatin
+      #
+      #   @param user_id [String] The ID of the user this digest instance belongs to.
+      #
+      #   @param categories [Array<Courier::Models::DigestCategory>] The categories configured for the digest.
+      #
+      #   @param category_key_counts [Hash{Symbol=>Integer}] A map of category key to the number of events received for that category.
+      #
+      #   @param created_at [String] An ISO 8601 timestamp of when the digest instance was created.
+      #
+      #   @param disabled [Boolean] Whether the digest instance has been disabled.
+      #
+      #   @param tenant_id [String, nil] The ID of the tenant this digest instance belongs to, if any.
+
+      # The status of the digest instance. `IN_PROGRESS` instances are still
+      # accumulating events; `COMPLETED` instances have been released.
+      #
+      # @see Courier::Models::DigestInstance#status
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        IN_PROGRESS = :IN_PROGRESS
+        COMPLETED = :COMPLETED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/digest_instance_list_response.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class DigestInstanceListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute has_more
+      #   Whether there are more digest instances to fetch using the cursor.
+      #
+      #   @return [Boolean]
+      required :has_more, Courier::Internal::Type::Boolean
+
+      # @!attribute items
+      #   The digest instances for this page of results.
+      #
+      #   @return [Array<Courier::Models::DigestInstance>]
+      required :items, -> { Courier::Internal::Type::ArrayOf[Courier::DigestInstance] }
+
+      # @!attribute type
+      #   Always `list` for a paginated list response.
+      #
+      #   @return [Symbol, Courier::Models::DigestInstanceListResponse::Type]
+      required :type, enum: -> { Courier::DigestInstanceListResponse::Type }
+
+      # @!attribute cursor
+      #   A cursor token for fetching the next page of results, or null when there are
+      #   none.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute next_url
+      #   The path to fetch the next page of results, or null when there are none.
+      #
+      #   @return [String, nil]
+      optional :next_url, String, nil?: true
+
+      # @!attribute url
+      #   The path of the current request.
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(has_more:, items:, type:, cursor: nil, next_url: nil, url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::DigestInstanceListResponse} for more details.
+      #
+      #   @param has_more [Boolean] Whether there are more digest instances to fetch using the cursor.
+      #
+      #   @param items [Array<Courier::Models::DigestInstance>] The digest instances for this page of results.
+      #
+      #   @param type [Symbol, Courier::Models::DigestInstanceListResponse::Type] Always `list` for a paginated list response.
+      #
+      #   @param cursor [String, nil] A cursor token for fetching the next page of results, or null when there are non
+      #
+      #   @param next_url [String, nil] The path to fetch the next page of results, or null when there are none.
+      #
+      #   @param url [String] The path of the current request.
+
+      # Always `list` for a paginated list response.
+      #
+      # @see Courier::Models::DigestInstanceListResponse#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        LIST = :list
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/digests/schedule_list_instances_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Digests
+      # @see Courier::Resources::Digests::Schedules#list_instances
+      class ScheduleListInstancesParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute schedule_id
+        #
+        #   @return [String]
+        required :schedule_id, String
+
+        # @!attribute cursor
+        #   A cursor token from a previous response, used to fetch the next page of results.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #   The maximum number of digest instances to return. Defaults to 20, with a maximum
+        #   of 100.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(schedule_id:, cursor: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Digests::ScheduleListInstancesParams} for more details.
+        #
+        #   @param schedule_id [String]
+        #
+        #   @param cursor [String] A cursor token from a previous response, used to fetch the next page of results.
+        #
+        #   @param limit [Integer] The maximum number of digest instances to return. Defaults to 20, with a maximum
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/digests/schedule_release_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Digests
+      # @see Courier::Resources::Digests::Schedules#release
+      class ScheduleReleaseParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute schedule_id
+        #
+        #   @return [String]
+        required :schedule_id, String
+
+        # @!method initialize(schedule_id:, request_options: {})
+        #   @param schedule_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models.rb

@@ -139,6 +139,14 @@ module Courier
 
   DeviceType = Courier::Models::DeviceType
 
+  DigestCategory = Courier::Models::DigestCategory
+
+  DigestInstance = Courier::Models::DigestInstance
+
+  DigestInstanceListResponse = Courier::Models::DigestInstanceListResponse
+
+  Digests = Courier::Models::Digests
+
   Discord = Courier::Models::Discord
 
   ElementalActionNodeWithType = Courier::Models::ElementalActionNodeWithType

data/lib/courier/resources/digests/schedules.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Digests
+      class Schedules
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Digests::ScheduleListInstancesParams} for more details.
+        #
+        # List the digest instances for a schedule. Each instance represents the events
+        # accumulated for a single user against the schedule, and can be used to monitor
+        # digest accumulation before the digest is released.
+        #
+        # @overload list_instances(schedule_id, cursor: nil, limit: nil, request_options: {})
+        #
+        # @param schedule_id [String] The ID of the digest schedule, in the form `sch/{uuid}`. The value must be URL-e
+        #
+        # @param cursor [String] A cursor token from a previous response, used to fetch the next page of results.
+        #
+        # @param limit [Integer] The maximum number of digest instances to return. Defaults to 20, with a maximum
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::DigestInstanceListResponse]
+        #
+        # @see Courier::Models::Digests::ScheduleListInstancesParams
+        def list_instances(schedule_id, params = {})
+          parsed, options = Courier::Digests::ScheduleListInstancesParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["digests/schedules/%1$s/instances", schedule_id],
+            query: query,
+            model: Courier::DigestInstanceListResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Digests::ScheduleReleaseParams} for more details.
+        #
+        # Send a digest now instead of waiting for its scheduled time, so your users get
+        # what they have collected so far right away.
+        #
+        # @overload release(schedule_id, request_options: {})
+        #
+        # @param schedule_id [String] The ID of the digest schedule to release, in the form `sch/{uuid}`. The value mu
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Courier::Models::Digests::ScheduleReleaseParams
+        def release(schedule_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["digests/schedules/%1$s/trigger", schedule_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Courier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/courier/resources/digests.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Digests
+      # @return [Courier::Resources::Digests::Schedules]
+      attr_reader :schedules
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+        @schedules = Courier::Resources::Digests::Schedules.new(client: client)
+      end
+    end
+  end
+end

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -134,6 +134,11 @@ require_relative "courier/models/channel_preference"
 require_relative "courier/models/check"
 require_relative "courier/models/default_preferences"
 require_relative "courier/models/device_type"
+require_relative "courier/models/digest_category"
+require_relative "courier/models/digest_instance"
+require_relative "courier/models/digest_instance_list_response"
+require_relative "courier/models/digests/schedule_list_instances_params"
+require_relative "courier/models/digests/schedule_release_params"
 require_relative "courier/models/discord"
 require_relative "courier/models/elemental_action_node_with_type"
 require_relative "courier/models/elemental_channel_node_with_type"
@@ -389,6 +394,8 @@ require_relative "courier/resources/automations"
 require_relative "courier/resources/automations/invoke"
 require_relative "courier/resources/brands"
 require_relative "courier/resources/bulk"
+require_relative "courier/resources/digests"
+require_relative "courier/resources/digests/schedules"
 require_relative "courier/resources/inbound"
 require_relative "courier/resources/journeys"
 require_relative "courier/resources/journeys/templates"

data/rbi/courier/client.rbi

@@ -40,6 +40,9 @@ module Courier
     sig { returns(Courier::Resources::Bulk) }
     attr_reader :bulk
 
+    sig { returns(Courier::Resources::Digests) }
+    attr_reader :digests
+
     sig { returns(Courier::Resources::Inbound) }
     attr_reader :inbound
 

data/rbi/courier/models/digest_category.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Courier
+  module Models
+    class DigestCategory < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::DigestCategory, Courier::Internal::AnyHash)
+        end
+
+      # The key that identifies the category within the digest.
+      sig { returns(String) }
+      attr_accessor :category_key
+
+      # Which events to keep when the number of events exceeds the retention limit for
+      # the category.
+      sig { returns(Courier::DigestCategory::Retain::TaggedSymbol) }
+      attr_accessor :retain
+
+      # The data key used to order events when `retain` is `highest` or `lowest`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :sort_key
+
+      sig { params(sort_key: String).void }
+      attr_writer :sort_key
+
+      sig do
+        params(
+          category_key: String,
+          retain: Courier::DigestCategory::Retain::OrSymbol,
+          sort_key: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The key that identifies the category within the digest.
+        category_key:,
+        # Which events to keep when the number of events exceeds the retention limit for
+        # the category.
+        retain:,
+        # The data key used to order events when `retain` is `highest` or `lowest`.
+        sort_key: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            category_key: String,
+            retain: Courier::DigestCategory::Retain::TaggedSymbol,
+            sort_key: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Which events to keep when the number of events exceeds the retention limit for
+      # the category.
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::DigestCategory::Retain) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FIRST = T.let(:first, Courier::DigestCategory::Retain::TaggedSymbol)
+        LAST = T.let(:last, Courier::DigestCategory::Retain::TaggedSymbol)
+        HIGHEST = T.let(:highest, Courier::DigestCategory::Retain::TaggedSymbol)
+        LOWEST = T.let(:lowest, Courier::DigestCategory::Retain::TaggedSymbol)
+        NONE = T.let(:none, Courier::DigestCategory::Retain::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::DigestCategory::Retain::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end