trycourier 4.10.2 → 4.11.0

data/rbi/courier/models/journey_template_replace_request.rbi

@@ -0,0 +1,368 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyTemplateReplaceRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneyTemplateReplaceRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::JourneyTemplateReplaceRequest::Notification) }
+      attr_reader :notification
+
+      sig do
+        params(
+          notification:
+            Courier::JourneyTemplateReplaceRequest::Notification::OrHash
+        ).void
+      end
+      attr_writer :notification
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :state
+
+      sig { params(state: String).void }
+      attr_writer :state
+
+      # Request body for replacing a journey-scoped notification template draft.
+      sig do
+        params(
+          notification:
+            Courier::JourneyTemplateReplaceRequest::Notification::OrHash,
+          state: String
+        ).returns(T.attached_class)
+      end
+      def self.new(notification:, state: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            notification: Courier::JourneyTemplateReplaceRequest::Notification,
+            state: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Notification < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::JourneyTemplateReplaceRequest::Notification,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::JourneyTemplateReplaceRequest::Notification::Brand
+            )
+          )
+        end
+        attr_reader :brand
+
+        sig do
+          params(
+            brand:
+              T.nilable(
+                Courier::JourneyTemplateReplaceRequest::Notification::Brand::OrHash
+              )
+          ).void
+        end
+        attr_writer :brand
+
+        sig do
+          returns(Courier::JourneyTemplateReplaceRequest::Notification::Content)
+        end
+        attr_reader :content
+
+        sig do
+          params(
+            content:
+              Courier::JourneyTemplateReplaceRequest::Notification::Content::OrHash
+          ).void
+        end
+        attr_writer :content
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          returns(
+            T.nilable(
+              Courier::JourneyTemplateReplaceRequest::Notification::Subscription
+            )
+          )
+        end
+        attr_reader :subscription
+
+        sig do
+          params(
+            subscription:
+              T.nilable(
+                Courier::JourneyTemplateReplaceRequest::Notification::Subscription::OrHash
+              )
+          ).void
+        end
+        attr_writer :subscription
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :tags
+
+        sig do
+          params(
+            brand:
+              T.nilable(
+                Courier::JourneyTemplateReplaceRequest::Notification::Brand::OrHash
+              ),
+            content:
+              Courier::JourneyTemplateReplaceRequest::Notification::Content::OrHash,
+            name: String,
+            subscription:
+              T.nilable(
+                Courier::JourneyTemplateReplaceRequest::Notification::Subscription::OrHash
+              ),
+            tags: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(brand:, content:, name:, subscription:, tags:)
+        end
+
+        sig do
+          override.returns(
+            {
+              brand:
+                T.nilable(
+                  Courier::JourneyTemplateReplaceRequest::Notification::Brand
+                ),
+              content:
+                Courier::JourneyTemplateReplaceRequest::Notification::Content,
+              name: String,
+              subscription:
+                T.nilable(
+                  Courier::JourneyTemplateReplaceRequest::Notification::Subscription
+                ),
+              tags: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Brand < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyTemplateReplaceRequest::Notification::Brand,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        class Content < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyTemplateReplaceRequest::Notification::Content,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                T.any(
+                  Courier::ElementalTextNodeWithType,
+                  Courier::ElementalMetaNodeWithType,
+                  Courier::ElementalChannelNodeWithType,
+                  Courier::ElementalImageNodeWithType,
+                  Courier::ElementalActionNodeWithType,
+                  Courier::ElementalDividerNodeWithType,
+                  Courier::ElementalQuoteNodeWithType,
+                  Courier::ElementalHTMLNodeWithType
+                )
+              ]
+            )
+          end
+          attr_accessor :elements
+
+          sig do
+            returns(
+              Courier::JourneyTemplateReplaceRequest::Notification::Content::Version::OrSymbol
+            )
+          end
+          attr_accessor :version
+
+          sig do
+            returns(
+              T.nilable(
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::OrSymbol
+              )
+            )
+          end
+          attr_reader :scope
+
+          sig do
+            params(
+              scope:
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::OrSymbol
+            ).void
+          end
+          attr_writer :scope
+
+          sig do
+            params(
+              elements:
+                T::Array[
+                  T.any(
+                    Courier::ElementalTextNodeWithType::OrHash,
+                    Courier::ElementalMetaNodeWithType::OrHash,
+                    Courier::ElementalChannelNodeWithType::OrHash,
+                    Courier::ElementalImageNodeWithType::OrHash,
+                    Courier::ElementalActionNodeWithType::OrHash,
+                    Courier::ElementalDividerNodeWithType::OrHash,
+                    Courier::ElementalQuoteNodeWithType::OrHash,
+                    Courier::ElementalHTMLNodeWithType::OrHash
+                  )
+                ],
+              version:
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Version::OrSymbol,
+              scope:
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(elements:, version:, scope: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                elements:
+                  T::Array[
+                    T.any(
+                      Courier::ElementalTextNodeWithType,
+                      Courier::ElementalMetaNodeWithType,
+                      Courier::ElementalChannelNodeWithType,
+                      Courier::ElementalImageNodeWithType,
+                      Courier::ElementalActionNodeWithType,
+                      Courier::ElementalDividerNodeWithType,
+                      Courier::ElementalQuoteNodeWithType,
+                      Courier::ElementalHTMLNodeWithType
+                    )
+                  ],
+                version:
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Version::OrSymbol,
+                scope:
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Version
+            extend Courier::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Version
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            VERSION_2022_01_01 =
+              T.let(
+                :"2022-01-01",
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Version::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Version::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Scope
+            extend Courier::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DEFAULT =
+              T.let(
+                :default,
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::TaggedSymbol
+              )
+            STRICT =
+              T.let(
+                :strict,
+                Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Courier::JourneyTemplateReplaceRequest::Notification::Content::Scope::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class Subscription < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneyTemplateReplaceRequest::Notification::Subscription,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :topic_id
+
+          sig { params(topic_id: String).returns(T.attached_class) }
+          def self.new(topic_id:)
+          end
+
+          sig { override.returns({ topic_id: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_template_summary.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyTemplateSummary < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyTemplateSummary, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      sig { returns(String) }
+      attr_accessor :creator
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(String) }
+      attr_accessor :state
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :tags
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :updated
+
+      sig { params(updated: Integer).void }
+      attr_writer :updated
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :updater
+
+      sig { params(updater: String).void }
+      attr_writer :updater
+
+      # Summary fields of a journey-scoped notification template returned in list
+      # responses.
+      sig do
+        params(
+          id: String,
+          created: Integer,
+          creator: String,
+          name: String,
+          state: String,
+          tags: T::Array[String],
+          updated: Integer,
+          updater: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created:,
+        creator:,
+        name:,
+        state:,
+        tags:,
+        updated: nil,
+        updater: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created: Integer,
+            creator: String,
+            name: String,
+            state: String,
+            tags: T::Array[String],
+            updated: Integer,
+            updater: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_throttle_dynamic_node.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneyThrottleDynamicNode < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneyThrottleDynamicNode, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :max_allowed
+
+      sig { returns(String) }
+      attr_accessor :period
+
+      sig { returns(Courier::JourneyThrottleDynamicNode::Scope::OrSymbol) }
+      attr_accessor :scope
+
+      sig { returns(String) }
+      attr_accessor :throttle_key
+
+      sig { returns(Courier::JourneyThrottleDynamicNode::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
+
+      # Throttle the journey by a dynamic `throttle_key`, allowing at most `max_allowed`
+      # invocations per `period`.
+      sig do
+        params(
+          max_allowed: Integer,
+          period: String,
+          scope: Courier::JourneyThrottleDynamicNode::Scope::OrSymbol,
+          throttle_key: String,
+          type: Courier::JourneyThrottleDynamicNode::Type::OrSymbol,
+          id: String,
+          conditions:
+            T.any(
+              T::Array[String],
+              Courier::JourneyConditionGroup::OrHash,
+              Courier::JourneyConditionNestedGroup::OrHash
+            )
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        max_allowed:,
+        period:,
+        scope:,
+        throttle_key:,
+        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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            max_allowed: Integer,
+            period: String,
+            scope: Courier::JourneyThrottleDynamicNode::Scope::OrSymbol,
+            throttle_key: String,
+            type: Courier::JourneyThrottleDynamicNode::Type::OrSymbol,
+            id: String,
+            conditions:
+              T.any(
+                T::Array[String],
+                Courier::JourneyConditionGroup,
+                Courier::JourneyConditionNestedGroup
+              )
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyThrottleDynamicNode::Scope)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DYNAMIC =
+          T.let(
+            :dynamic,
+            Courier::JourneyThrottleDynamicNode::Scope::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyThrottleDynamicNode::Scope::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::JourneyThrottleDynamicNode::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        THROTTLE =
+          T.let(
+            :throttle,
+            Courier::JourneyThrottleDynamicNode::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::JourneyThrottleDynamicNode::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end