trycourier 4.10.2 → 4.11.0

data/rbi/courier/models/journey_node.rbi

@@ -0,0 +1,227 @@
+# typed: strong
+
+module Courier
+  module Models
+    # A single node in a journey DAG. Discriminated by `type`, with a secondary
+    # discriminator on some variants (`trigger_type` for trigger, `mode` for delay,
+    # `method` for fetch, `scope` for throttle).
+    module JourneyNode
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::JourneyAPIInvokeTriggerNode,
+            Courier::JourneySegmentTriggerNode,
+            Courier::JourneySendNode,
+            Courier::JourneyDelayDurationNode,
+            Courier::JourneyDelayUntilNode,
+            Courier::JourneyFetchGetDeleteNode,
+            Courier::JourneyFetchPostPutNode,
+            Courier::JourneyAINode,
+            Courier::JourneyThrottleStaticNode,
+            Courier::JourneyThrottleDynamicNode,
+            Courier::JourneyExitNode,
+            Courier::JourneyNode::JourneyBranchNode
+          )
+        end
+
+      class JourneyBranchNode < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::JourneyNode::JourneyBranchNode,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Courier::JourneyNode::JourneyBranchNode::Default) }
+        attr_reader :default
+
+        sig do
+          params(
+            default: Courier::JourneyNode::JourneyBranchNode::Default::OrHash
+          ).void
+        end
+        attr_writer :default
+
+        sig { returns(T::Array[Courier::JourneyNode::JourneyBranchNode::Path]) }
+        attr_accessor :paths
+
+        sig { returns(Courier::JourneyNode::JourneyBranchNode::Type::OrSymbol) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Branch node. Routes to the first entry in `paths[]` whose `conditions` match,
+        # else falls through to `default.nodes`.
+        sig do
+          params(
+            default: Courier::JourneyNode::JourneyBranchNode::Default::OrHash,
+            paths:
+              T::Array[Courier::JourneyNode::JourneyBranchNode::Path::OrHash],
+            type: Courier::JourneyNode::JourneyBranchNode::Type::OrSymbol,
+            id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(default:, paths:, type:, id: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              default: Courier::JourneyNode::JourneyBranchNode::Default,
+              paths: T::Array[Courier::JourneyNode::JourneyBranchNode::Path],
+              type: Courier::JourneyNode::JourneyBranchNode::Type::OrSymbol,
+              id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Default < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyNode::JourneyBranchNode::Default,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[Courier::JourneyNode]) }
+          attr_accessor :nodes
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :label
+
+          sig { params(label: String).void }
+          attr_writer :label
+
+          sig do
+            params(
+              nodes: T::Array[Courier::JourneyNode],
+              label: String
+            ).returns(T.attached_class)
+          end
+          def self.new(nodes:, label: nil)
+          end
+
+          sig do
+            override.returns(
+              { nodes: T::Array[Courier::JourneyNode], label: String }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Path < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyNode::JourneyBranchNode::Path,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          # 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.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              )
+            )
+          end
+          attr_accessor :conditions
+
+          sig { returns(T::Array[Courier::JourneyNode]) }
+          attr_accessor :nodes
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :label
+
+          sig { params(label: String).void }
+          attr_writer :label
+
+          sig do
+            params(
+              conditions:
+                T.any(
+                  T::Array[String],
+                  Courier::JourneyConditionGroup::OrHash,
+                  Courier::JourneyConditionNestedGroup::OrHash
+                ),
+              nodes: T::Array[Courier::JourneyNode],
+              label: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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:,
+            nodes:,
+            label: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                conditions:
+                  T.any(
+                    T::Array[String],
+                    Courier::JourneyConditionGroup,
+                    Courier::JourneyConditionNestedGroup
+                  ),
+                nodes: T::Array[Courier::JourneyNode],
+                label: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Courier::JourneyNode::JourneyBranchNode::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BRANCH =
+            T.let(
+              :branch,
+              Courier::JourneyNode::JourneyBranchNode::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::JourneyNode::JourneyBranchNode::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      sig { override.returns(T::Array[Courier::JourneyNode::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_publish_params.rbi

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

data/rbi/courier/models/journey_publish_request.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyPublishRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyPublishRequest, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      # Request body for publishing a journey. Pass `version` to roll back to a prior
+      # version; omit to publish the current draft.
+      sig { params(version: String).returns(T.attached_class) }
+      def self.new(version: nil)
+      end
+
+      sig { override.returns({ version: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_replace_params.rbi

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

data/rbi/courier/models/journey_response.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyResponse, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :created
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :creator
+
+      sig { returns(T::Boolean) }
+      attr_accessor :enabled
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T::Array[Courier::JourneyNode::Variants]) }
+      attr_accessor :nodes
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :published
+
+      # Lifecycle state of a journey.
+      sig { returns(Courier::JourneyState::TaggedSymbol) }
+      attr_accessor :state
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :updated
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :updater
+
+      # A journey, with its current draft or published nodes and metadata.
+      sig do
+        params(
+          id: String,
+          created: T.nilable(Integer),
+          creator: T.nilable(String),
+          enabled: T::Boolean,
+          name: String,
+          nodes:
+            T::Array[
+              T.any(
+                Courier::JourneyAPIInvokeTriggerNode::OrHash,
+                Courier::JourneySegmentTriggerNode::OrHash,
+                Courier::JourneySendNode::OrHash,
+                Courier::JourneyDelayDurationNode::OrHash,
+                Courier::JourneyDelayUntilNode::OrHash,
+                Courier::JourneyFetchGetDeleteNode::OrHash,
+                Courier::JourneyFetchPostPutNode::OrHash,
+                Courier::JourneyAINode::OrHash,
+                Courier::JourneyThrottleStaticNode::OrHash,
+                Courier::JourneyThrottleDynamicNode::OrHash,
+                Courier::JourneyExitNode::OrHash,
+                Courier::JourneyNode::JourneyBranchNode::OrHash
+              )
+            ],
+          published: T.nilable(Integer),
+          state: Courier::JourneyState::OrSymbol,
+          updated: T.nilable(Integer),
+          updater: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created:,
+        creator:,
+        enabled:,
+        name:,
+        nodes:,
+        published:,
+        # Lifecycle state of a journey.
+        state:,
+        updated:,
+        updater:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created: T.nilable(Integer),
+            creator: T.nilable(String),
+            enabled: T::Boolean,
+            name: String,
+            nodes: T::Array[Courier::JourneyNode::Variants],
+            published: T.nilable(Integer),
+            state: Courier::JourneyState::TaggedSymbol,
+            updated: T.nilable(Integer),
+            updater: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_retrieve_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyRetrieveParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :template_id
+
+      # Version selector: `draft`, `published` (default), or `vN`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      sig do
+        params(
+          template_id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        template_id:,
+        # Version selector: `draft`, `published` (default), or `vN`.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            template_id: String,
+            version: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_segment_trigger_node.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneySegmentTriggerNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneySegmentTriggerNode, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Courier::JourneySegmentTriggerNode::RequestType::OrSymbol) }
+      attr_accessor :request_type
+
+      sig { returns(Courier::JourneySegmentTriggerNode::TriggerType::OrSymbol) }
+      attr_accessor :trigger_type
+
+      sig { returns(Courier::JourneySegmentTriggerNode::Type::OrSymbol) }
+      attr_accessor :type
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # 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
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :event_id
+
+      sig { params(event_id: String).void }
+      attr_writer :event_id
+
+      # Trigger fired by a segment event (`identify`, `group`, or `track`).
+      sig do
+        params(
+          request_type:
+            Courier::JourneySegmentTriggerNode::RequestType::OrSymbol,
+          trigger_type:
+            Courier::JourneySegmentTriggerNode::TriggerType::OrSymbol,
+          type: Courier::JourneySegmentTriggerNode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            ),
+          event_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        request_type:,
+        trigger_type:,
+        type:,
+        id: 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,
+        event_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            request_type:
+              Courier::JourneySegmentTriggerNode::RequestType::OrSymbol,
+            trigger_type:
+              Courier::JourneySegmentTriggerNode::TriggerType::OrSymbol,
+            type: Courier::JourneySegmentTriggerNode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              ),
+            event_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module RequestType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneySegmentTriggerNode::RequestType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IDENTIFY =
+          T.let(
+            :identify,
+            Courier::JourneySegmentTriggerNode::RequestType::TaggedSymbol
+          )
+        GROUP =
+          T.let(
+            :group,
+            Courier::JourneySegmentTriggerNode::RequestType::TaggedSymbol
+          )
+        TRACK =
+          T.let(
+            :track,
+            Courier::JourneySegmentTriggerNode::RequestType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::JourneySegmentTriggerNode::RequestType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneySegmentTriggerNode::TriggerType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SEGMENT =
+          T.let(
+            :segment,
+            Courier::JourneySegmentTriggerNode::TriggerType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::JourneySegmentTriggerNode::TriggerType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneySegmentTriggerNode::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRIGGER =
+          T.let(
+            :trigger,
+            Courier::JourneySegmentTriggerNode::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneySegmentTriggerNode::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end