trycourier 4.11.0 → 4.13.0

data/rbi/courier/models/journey_node.rbi

@@ -21,11 +21,326 @@ module Courier
             Courier::JourneyAINode,
             Courier::JourneyThrottleStaticNode,
             Courier::JourneyThrottleDynamicNode,
+            Courier::JourneyNode::JourneyBatchNode,
             Courier::JourneyExitNode,
             Courier::JourneyNode::JourneyBranchNode
           )
         end
 
+      class JourneyBatchNode < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::JourneyNode::JourneyBatchNode,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+        # the batch unconditionally when it elapses.
+        sig { returns(String) }
+        attr_accessor :max_wait_period
+
+        # How to select which collected events to retain in the aggregated payload when
+        # the batch releases.
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Retain) }
+        attr_reader :retain
+
+        sig do
+          params(
+            retain: Courier::JourneyNode::JourneyBatchNode::Retain::OrHash
+          ).void
+        end
+        attr_writer :retain
+
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol) }
+        attr_accessor :scope
+
+        sig { returns(Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol) }
+        attr_accessor :type
+
+        # ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+        # new contributing events. Must be less than `max_wait_period`.
+        sig { returns(String) }
+        attr_accessor :wait_period
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Optional partition key. Events with the same `category_key` are batched
+        # together; events with different values are batched separately.
+        sig { returns(T.nilable(String)) }
+        attr_reader :category_key
+
+        sig { params(category_key: String).void }
+        attr_writer :category_key
+
+        # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+        # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+        # express "no conditions".
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              )
+            )
+          )
+        end
+        attr_reader :conditions
+
+        sig do
+          params(
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup::OrHash,
+                Courier::JourneyConditionNestedGroup::OrHash
+              )
+          ).void
+        end
+        attr_writer :conditions
+
+        # Releases the batch once this many events have been collected.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_items
+
+        sig { params(max_items: Integer).void }
+        attr_writer :max_items
+
+        # Collect events arriving at the node into a single batch and fire one downstream
+        # step with the aggregated payload. The first event into a batch owns the run;
+        # later contributing events terminate at the batch step. The batch releases when
+        # any of `max_items` is reached, a quiet window of `wait_period` elapses, or the
+        # `max_wait_period` ceiling hits.
+        sig do
+          params(
+            max_wait_period: String,
+            retain: Courier::JourneyNode::JourneyBatchNode::Retain::OrHash,
+            scope: Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol,
+            type: Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol,
+            wait_period: String,
+            id: String,
+            category_key: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup::OrHash,
+                Courier::JourneyConditionNestedGroup::OrHash
+              ),
+            max_items: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # ISO 8601 duration. Hard ceiling from the first event into the batch; releases
+          # the batch unconditionally when it elapses.
+          max_wait_period:,
+          # How to select which collected events to retain in the aggregated payload when
+          # the batch releases.
+          retain:,
+          scope:,
+          type:,
+          # ISO 8601 duration. Quiet window that releases the batch when it elapses with no
+          # new contributing events. Must be less than `max_wait_period`.
+          wait_period:,
+          id: nil,
+          # Optional partition key. Events with the same `category_key` are batched
+          # together; events with different values are batched separately.
+          category_key: nil,
+          # Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+          # group, or an AND/OR nested group. Omit the `conditions` property entirely to
+          # express "no conditions".
+          conditions: nil,
+          # Releases the batch once this many events have been collected.
+          max_items: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              max_wait_period: String,
+              retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+              scope: Courier::JourneyNode::JourneyBatchNode::Scope::OrSymbol,
+              type: Courier::JourneyNode::JourneyBatchNode::Type::OrSymbol,
+              wait_period: String,
+              id: String,
+              category_key: String,
+              conditions:
+                T.any(
+                  T::Array[String],
+                  Courier::JourneyConditionGroup,
+                  Courier::JourneyConditionNestedGroup
+                ),
+              max_items: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Retain < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyNode::JourneyBatchNode::Retain,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Integer) }
+          attr_accessor :count
+
+          sig do
+            returns(
+              Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol
+            )
+          end
+          attr_accessor :type
+
+          # Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+          # `highest` or `lowest`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sort_key
+
+          sig { params(sort_key: String).void }
+          attr_writer :sort_key
+
+          # How to select which collected events to retain in the aggregated payload when
+          # the batch releases.
+          sig do
+            params(
+              count: Integer,
+              type:
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol,
+              sort_key: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            count:,
+            type:,
+            # Dot-path into the event payload (e.g. `data.priority`). Required when `type` is
+            # `highest` or `lowest`.
+            sort_key: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                count: Integer,
+                type:
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type::OrSymbol,
+                sort_key: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Type
+            extend Courier::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIRST =
+              T.let(
+                :first,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            LAST =
+              T.let(
+                :last,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            HIGHEST =
+              T.let(
+                :highest,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+            LOWEST =
+              T.let(
+                :lowest,
+                Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Courier::JourneyNode::JourneyBatchNode::Retain::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::JourneyNode::JourneyBatchNode::Scope)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          USER =
+            T.let(
+              :user,
+              Courier::JourneyNode::JourneyBatchNode::Scope::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::JourneyNode::JourneyBatchNode::Scope::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::JourneyNode::JourneyBatchNode::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BATCH =
+            T.let(
+              :batch,
+              Courier::JourneyNode::JourneyBatchNode::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::JourneyNode::JourneyBatchNode::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class JourneyBranchNode < Courier::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/rbi/courier/models/journey_response.rbi

@@ -60,6 +60,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )

data/rbi/courier/models.rbi

@@ -103,6 +103,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/rbi/courier/resources/brands.rbi

@@ -3,23 +3,18 @@
 module Courier
   module Resources
     class Brands
-      # Create a new brand
+      # Create a new brand. Requires `name` and `settings` (with at least
+      # `colors.primary` and `colors.secondary`).
       sig do
         params(
           name: String,
+          settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
-          settings: T.nilable(Courier::BrandSettings::OrHash),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::Brand)
       end
-      def create(
-        name:,
-        id: nil,
-        settings: nil,
-        snippets: nil,
-        request_options: {}
-      )
+      def create(name:, settings:, id: nil, snippets: nil, request_options: {})
       end
 
       # Fetch a specific brand by brand ID.

data/rbi/courier/resources/digests/schedules.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Digests
+      class Schedules
+        # 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.
+        sig do
+          params(
+            schedule_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::DigestInstanceListResponse)
+        end
+        def list_instances(
+          # The ID of the digest schedule, in the form `sch/{uuid}`. The value must be
+          # URL-encoded (e.g. `sch%2F00000000-0000-0000-0000-000000000000`).
+          schedule_id,
+          # A cursor token from a previous response, used to fetch the next page of results.
+          cursor: nil,
+          # The maximum number of digest instances to return. Defaults to 20, with a maximum
+          # of 100.
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # Send a digest now instead of waiting for its scheduled time, so your users get
+        # what they have collected so far right away.
+        sig do
+          params(
+            schedule_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def release(
+          # The ID of the digest schedule to release, in the form `sch/{uuid}`. The value
+          # must be URL-encoded (e.g. `sch%2F00000000-0000-0000-0000-000000000000`).
+          schedule_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Courier::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/courier/resources/digests.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Digests
+      sig { returns(Courier::Resources::Digests::Schedules) }
+      attr_reader :schedules
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/courier/resources/journeys.rbi

@@ -28,6 +28,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )
@@ -187,6 +188,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )

data/sig/courier/client.rbs

@@ -28,6 +28,8 @@ module Courier
 
     attr_reader bulk: Courier::Resources::Bulk
 
+    attr_reader digests: Courier::Resources::Digests
+
     attr_reader inbound: Courier::Resources::Inbound
 
     attr_reader lists: Courier::Resources::Lists

data/sig/courier/models/brand_create_params.rbs

@@ -3,8 +3,8 @@ module Courier
     type brand_create_params =
       {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?
       }
       & Courier::Internal::Type::request_parameters
@@ -15,24 +15,24 @@ module Courier
 
       attr_accessor name: String
 
-      attr_accessor id: String?
+      attr_accessor settings: Courier::BrandSettings
 
-      attr_accessor settings: Courier::BrandSettings?
+      attr_accessor id: String?
 
       attr_accessor snippets: Courier::BrandSnippets?
 
       def initialize: (
         name: String,
+        settings: Courier::BrandSettings,
         ?id: String?,
-        ?settings: Courier::BrandSettings?,
         ?snippets: Courier::BrandSnippets?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
         name: String,
+        settings: Courier::BrandSettings,
         id: String?,
-        settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/digest_category.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Models
+    type digest_category =
+      {
+        category_key: String,
+        retain: Courier::Models::DigestCategory::retain,
+        sort_key: String
+      }
+
+    class DigestCategory < Courier::Internal::Type::BaseModel
+      attr_accessor category_key: String
+
+      attr_accessor retain: Courier::Models::DigestCategory::retain
+
+      attr_reader sort_key: String?
+
+      def sort_key=: (String) -> String
+
+      def initialize: (
+        category_key: String,
+        retain: Courier::Models::DigestCategory::retain,
+        ?sort_key: String
+      ) -> void
+
+      def to_hash: -> {
+        category_key: String,
+        retain: Courier::Models::DigestCategory::retain,
+        sort_key: String
+      }
+
+      type retain = :first | :last | :highest | :lowest | :none
+
+      module Retain
+        extend Courier::Internal::Type::Enum
+
+        FIRST: :first
+        LAST: :last
+        HIGHEST: :highest
+        LOWEST: :lowest
+        NONE: :none
+
+        def self?.values: -> ::Array[Courier::Models::DigestCategory::retain]
+      end
+    end
+  end
+end

data/sig/courier/models/digest_instance.rbs

@@ -0,0 +1,83 @@
+module Courier
+  module Models
+    type digest_instance =
+      {
+        digest_instance_id: String,
+        event_count: Integer,
+        status: Courier::Models::DigestInstance::status,
+        user_id: String,
+        categories: ::Array[Courier::DigestCategory],
+        category_key_counts: ::Hash[Symbol, Integer],
+        created_at: String,
+        disabled: bool,
+        tenant_id: String?
+      }
+
+    class DigestInstance < Courier::Internal::Type::BaseModel
+      attr_accessor digest_instance_id: String
+
+      attr_accessor event_count: Integer
+
+      attr_accessor status: Courier::Models::DigestInstance::status
+
+      attr_accessor user_id: String
+
+      attr_reader categories: ::Array[Courier::DigestCategory]?
+
+      def categories=: (
+        ::Array[Courier::DigestCategory]
+      ) -> ::Array[Courier::DigestCategory]
+
+      attr_reader category_key_counts: ::Hash[Symbol, Integer]?
+
+      def category_key_counts=: (
+        ::Hash[Symbol, Integer]
+      ) -> ::Hash[Symbol, Integer]
+
+      attr_reader created_at: String?
+
+      def created_at=: (String) -> String
+
+      attr_reader disabled: bool?
+
+      def disabled=: (bool) -> bool
+
+      attr_accessor tenant_id: String?
+
+      def initialize: (
+        digest_instance_id: String,
+        event_count: Integer,
+        status: Courier::Models::DigestInstance::status,
+        user_id: String,
+        ?categories: ::Array[Courier::DigestCategory],
+        ?category_key_counts: ::Hash[Symbol, Integer],
+        ?created_at: String,
+        ?disabled: bool,
+        ?tenant_id: String?
+      ) -> void
+
+      def to_hash: -> {
+        digest_instance_id: String,
+        event_count: Integer,
+        status: Courier::Models::DigestInstance::status,
+        user_id: String,
+        categories: ::Array[Courier::DigestCategory],
+        category_key_counts: ::Hash[Symbol, Integer],
+        created_at: String,
+        disabled: bool,
+        tenant_id: String?
+      }
+
+      type status = :IN_PROGRESS | :COMPLETED
+
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        IN_PROGRESS: :IN_PROGRESS
+        COMPLETED: :COMPLETED
+
+        def self?.values: -> ::Array[Courier::Models::DigestInstance::status]
+      end
+    end
+  end
+end

data/sig/courier/models/digest_instance_list_response.rbs

@@ -0,0 +1,57 @@
+module Courier
+  module Models
+    type digest_instance_list_response =
+      {
+        has_more: bool,
+        items: ::Array[Courier::DigestInstance],
+        type: Courier::Models::DigestInstanceListResponse::type_,
+        cursor: String?,
+        next_url: String?,
+        url: String
+      }
+
+    class DigestInstanceListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor has_more: bool
+
+      attr_accessor items: ::Array[Courier::DigestInstance]
+
+      attr_accessor type: Courier::Models::DigestInstanceListResponse::type_
+
+      attr_accessor cursor: String?
+
+      attr_accessor next_url: String?
+
+      attr_reader url: String?
+
+      def url=: (String) -> String
+
+      def initialize: (
+        has_more: bool,
+        items: ::Array[Courier::DigestInstance],
+        type: Courier::Models::DigestInstanceListResponse::type_,
+        ?cursor: String?,
+        ?next_url: String?,
+        ?url: String
+      ) -> void
+
+      def to_hash: -> {
+        has_more: bool,
+        items: ::Array[Courier::DigestInstance],
+        type: Courier::Models::DigestInstanceListResponse::type_,
+        cursor: String?,
+        next_url: String?,
+        url: String
+      }
+
+      type type_ = :list
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        LIST: :list
+
+        def self?.values: -> ::Array[Courier::Models::DigestInstanceListResponse::type_]
+      end
+    end
+  end
+end