trycourier 4.12.0 → 4.13.0

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

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/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/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/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

data/sig/courier/models/digests/schedule_list_instances_params.rbs

@@ -0,0 +1,38 @@
+module Courier
+  module Models
+    module Digests
+      type schedule_list_instances_params =
+        { schedule_id: String, cursor: String, limit: Integer }
+        & Courier::Internal::Type::request_parameters
+
+      class ScheduleListInstancesParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor schedule_id: String
+
+        attr_reader cursor: String?
+
+        def cursor=: (String) -> String
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        def initialize: (
+          schedule_id: String,
+          ?cursor: String,
+          ?limit: Integer,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          schedule_id: String,
+          cursor: String,
+          limit: Integer,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/digests/schedule_release_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    module Digests
+      type schedule_release_params =
+        { schedule_id: String } & Courier::Internal::Type::request_parameters
+
+      class ScheduleReleaseParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor schedule_id: String
+
+        def initialize: (
+          schedule_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          schedule_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end