trycourier 4.11.0 → 4.13.0

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/resources/journeys.rb

@@ -17,7 +17,7 @@ module Courier
       #
       # @param name [String]
       #
-      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       # @param enabled [Boolean]
       #
@@ -204,7 +204,7 @@ module Courier
       #
       # @param name [String]
       #
-      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
+      # @param nodes [Array<Courier::Models::JourneyAPIInvokeTriggerNode, Courier::Models::JourneySegmentTriggerNode, Courier::Models::JourneySendNode, Courier::Models::JourneyDelayDurationNode, Courier::Models::JourneyDelayUntilNode, Courier::Models::JourneyFetchGetDeleteNode, Courier::Models::JourneyFetchPostPutNode, Courier::Models::JourneyAINode, Courier::Models::JourneyThrottleStaticNode, Courier::Models::JourneyThrottleDynamicNode, Courier::Models::JourneyNode::JourneyBatchNode, Courier::Models::JourneyExitNode, Courier::Models::JourneyNode::JourneyBranchNode>]
       #
       # @param enabled [Boolean]
       #

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.11.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/brand_create_params.rbi

@@ -14,15 +14,15 @@ module Courier
       sig { returns(String) }
       attr_accessor :name
 
-      sig { returns(T.nilable(String)) }
-      attr_accessor :id
-
-      sig { returns(T.nilable(Courier::BrandSettings)) }
+      sig { returns(Courier::BrandSettings) }
       attr_reader :settings
 
-      sig { params(settings: T.nilable(Courier::BrandSettings::OrHash)).void }
+      sig { params(settings: Courier::BrandSettings::OrHash).void }
       attr_writer :settings
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+
       sig { returns(T.nilable(Courier::BrandSnippets)) }
       attr_reader :snippets
 
@@ -32,16 +32,16 @@ module Courier
       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(T.attached_class)
       end
       def self.new(
         name:,
+        settings:,
         id: nil,
-        settings: nil,
         snippets: nil,
         request_options: {}
       )
@@ -51,8 +51,8 @@ module Courier
         override.returns(
           {
             name: String,
+            settings: Courier::BrandSettings,
             id: T.nilable(String),
-            settings: T.nilable(Courier::BrandSettings),
             snippets: T.nilable(Courier::BrandSnippets),
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/create_journey_request.rbi

@@ -25,6 +25,7 @@ module Courier
               Courier::JourneyAINode,
               Courier::JourneyThrottleStaticNode,
               Courier::JourneyThrottleDynamicNode,
+              Courier::JourneyNode::JourneyBatchNode,
               Courier::JourneyExitNode,
               Courier::JourneyNode::JourneyBranchNode
             )
@@ -63,6 +64,7 @@ module Courier
                 Courier::JourneyAINode::OrHash,
                 Courier::JourneyThrottleStaticNode::OrHash,
                 Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyNode::JourneyBatchNode::OrHash,
                 Courier::JourneyExitNode::OrHash,
                 Courier::JourneyNode::JourneyBranchNode::OrHash
               )
@@ -97,6 +99,7 @@ module Courier
                   Courier::JourneyAINode,
                   Courier::JourneyThrottleStaticNode,
                   Courier::JourneyThrottleDynamicNode,
+                  Courier::JourneyNode::JourneyBatchNode,
                   Courier::JourneyExitNode,
                   Courier::JourneyNode::JourneyBranchNode
                 )

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

data/rbi/courier/models/digest_instance.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module Courier
+  module Models
+    class DigestInstance < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::DigestInstance, Courier::Internal::AnyHash)
+        end
+
+      # A unique identifier for the digest instance.
+      sig { returns(String) }
+      attr_accessor :digest_instance_id
+
+      # The total number of events received for this instance.
+      sig { returns(Integer) }
+      attr_accessor :event_count
+
+      # The status of the digest instance. `IN_PROGRESS` instances are still
+      # accumulating events; `COMPLETED` instances have been released.
+      sig { returns(Courier::DigestInstance::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # The ID of the user this digest instance belongs to.
+      sig { returns(String) }
+      attr_accessor :user_id
+
+      # The categories configured for the digest.
+      sig { returns(T.nilable(T::Array[Courier::DigestCategory])) }
+      attr_reader :categories
+
+      sig { params(categories: T::Array[Courier::DigestCategory::OrHash]).void }
+      attr_writer :categories
+
+      # A map of category key to the number of events received for that category.
+      sig { returns(T.nilable(T::Hash[Symbol, Integer])) }
+      attr_reader :category_key_counts
+
+      sig { params(category_key_counts: T::Hash[Symbol, Integer]).void }
+      attr_writer :category_key_counts
+
+      # An ISO 8601 timestamp of when the digest instance was created.
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_at
+
+      sig { params(created_at: String).void }
+      attr_writer :created_at
+
+      # Whether the digest instance has been disabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :disabled
+
+      sig { params(disabled: T::Boolean).void }
+      attr_writer :disabled
+
+      # The ID of the tenant this digest instance belongs to, if any.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tenant_id
+
+      sig do
+        params(
+          digest_instance_id: String,
+          event_count: Integer,
+          status: Courier::DigestInstance::Status::OrSymbol,
+          user_id: String,
+          categories: T::Array[Courier::DigestCategory::OrHash],
+          category_key_counts: T::Hash[Symbol, Integer],
+          created_at: String,
+          disabled: T::Boolean,
+          tenant_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique identifier for the digest instance.
+        digest_instance_id:,
+        # The total number of events received for this instance.
+        event_count:,
+        # The status of the digest instance. `IN_PROGRESS` instances are still
+        # accumulating events; `COMPLETED` instances have been released.
+        status:,
+        # The ID of the user this digest instance belongs to.
+        user_id:,
+        # The categories configured for the digest.
+        categories: nil,
+        # A map of category key to the number of events received for that category.
+        category_key_counts: nil,
+        # An ISO 8601 timestamp of when the digest instance was created.
+        created_at: nil,
+        # Whether the digest instance has been disabled.
+        disabled: nil,
+        # The ID of the tenant this digest instance belongs to, if any.
+        tenant_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            digest_instance_id: String,
+            event_count: Integer,
+            status: Courier::DigestInstance::Status::TaggedSymbol,
+            user_id: String,
+            categories: T::Array[Courier::DigestCategory],
+            category_key_counts: T::Hash[Symbol, Integer],
+            created_at: String,
+            disabled: T::Boolean,
+            tenant_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the digest instance. `IN_PROGRESS` instances are still
+      # accumulating events; `COMPLETED` instances have been released.
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::DigestInstance::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IN_PROGRESS =
+          T.let(:IN_PROGRESS, Courier::DigestInstance::Status::TaggedSymbol)
+        COMPLETED =
+          T.let(:COMPLETED, Courier::DigestInstance::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::DigestInstance::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/digest_instance_list_response.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Courier
+  module Models
+    class DigestInstanceListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::DigestInstanceListResponse, Courier::Internal::AnyHash)
+        end
+
+      # Whether there are more digest instances to fetch using the cursor.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      # The digest instances for this page of results.
+      sig { returns(T::Array[Courier::DigestInstance]) }
+      attr_accessor :items
+
+      # Always `list` for a paginated list response.
+      sig { returns(Courier::DigestInstanceListResponse::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # A cursor token for fetching the next page of results, or null when there are
+      # none.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      # The path to fetch the next page of results, or null when there are none.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_url
+
+      # The path of the current request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :url
+
+      sig { params(url: String).void }
+      attr_writer :url
+
+      sig do
+        params(
+          has_more: T::Boolean,
+          items: T::Array[Courier::DigestInstance::OrHash],
+          type: Courier::DigestInstanceListResponse::Type::OrSymbol,
+          cursor: T.nilable(String),
+          next_url: T.nilable(String),
+          url: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Whether there are more digest instances to fetch using the cursor.
+        has_more:,
+        # The digest instances for this page of results.
+        items:,
+        # Always `list` for a paginated list response.
+        type:,
+        # A cursor token for fetching the next page of results, or null when there are
+        # none.
+        cursor: nil,
+        # The path to fetch the next page of results, or null when there are none.
+        next_url: nil,
+        # The path of the current request.
+        url: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            has_more: T::Boolean,
+            items: T::Array[Courier::DigestInstance],
+            type: Courier::DigestInstanceListResponse::Type::TaggedSymbol,
+            cursor: T.nilable(String),
+            next_url: T.nilable(String),
+            url: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Always `list` for a paginated list response.
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::DigestInstanceListResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(:list, Courier::DigestInstanceListResponse::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::DigestInstanceListResponse::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/digests/schedule_list_instances_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Digests
+      class ScheduleListInstancesParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Digests::ScheduleListInstancesParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :schedule_id
+
+        # A cursor token from a previous response, used to fetch the next page of results.
+        sig { returns(T.nilable(String)) }
+        attr_reader :cursor
+
+        sig { params(cursor: String).void }
+        attr_writer :cursor
+
+        # The maximum number of digest instances to return. Defaults to 20, with a maximum
+        # of 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          params(
+            schedule_id: String,
+            cursor: String,
+            limit: Integer,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          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
+
+        sig do
+          override.returns(
+            {
+              schedule_id: String,
+              cursor: String,
+              limit: Integer,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/digests/schedule_release_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Digests
+      class ScheduleReleaseParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Digests::ScheduleReleaseParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :schedule_id
+
+        sig do
+          params(
+            schedule_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(schedule_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { schedule_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end