trycourier 4.10.2 → 4.12.0

data/sig/courier/models/journey_node.rbs

@@ -0,0 +1,247 @@
+module Courier
+  module Models
+    type journey_node =
+      Courier::JourneyAPIInvokeTriggerNode
+      | Courier::JourneySegmentTriggerNode
+      | Courier::JourneySendNode
+      | Courier::JourneyDelayDurationNode
+      | Courier::JourneyDelayUntilNode
+      | Courier::JourneyFetchGetDeleteNode
+      | Courier::JourneyFetchPostPutNode
+      | Courier::JourneyAINode
+      | Courier::JourneyThrottleStaticNode
+      | Courier::JourneyThrottleDynamicNode
+      | Courier::JourneyNode::JourneyBatchNode
+      | Courier::JourneyExitNode
+      | Courier::JourneyNode::JourneyBranchNode
+
+    module JourneyNode
+      extend Courier::Internal::Type::Union
+
+      type journey_batch_node =
+        {
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          id: String,
+          category_key: String,
+          conditions: Courier::Models::journey_conditions_field,
+          max_items: Integer
+        }
+
+      class JourneyBatchNode < Courier::Internal::Type::BaseModel
+        attr_accessor max_wait_period: String
+
+        attr_accessor retain: Courier::JourneyNode::JourneyBatchNode::Retain
+
+        attr_accessor scope: Courier::Models::JourneyNode::JourneyBatchNode::scope
+
+        attr_accessor type: Courier::Models::JourneyNode::JourneyBatchNode::type_
+
+        attr_accessor wait_period: String
+
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader category_key: String?
+
+        def category_key=: (String) -> String
+
+        attr_reader conditions: Courier::Models::journey_conditions_field?
+
+        def conditions=: (
+          Courier::Models::journey_conditions_field
+        ) -> Courier::Models::journey_conditions_field
+
+        attr_reader max_items: Integer?
+
+        def max_items=: (Integer) -> Integer
+
+        def initialize: (
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          ?id: String,
+          ?category_key: String,
+          ?conditions: Courier::Models::journey_conditions_field,
+          ?max_items: Integer
+        ) -> void
+
+        def to_hash: -> {
+          max_wait_period: String,
+          retain: Courier::JourneyNode::JourneyBatchNode::Retain,
+          scope: Courier::Models::JourneyNode::JourneyBatchNode::scope,
+          type: Courier::Models::JourneyNode::JourneyBatchNode::type_,
+          wait_period: String,
+          id: String,
+          category_key: String,
+          conditions: Courier::Models::journey_conditions_field,
+          max_items: Integer
+        }
+
+        type retain =
+          {
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            sort_key: String
+          }
+
+        class Retain < Courier::Internal::Type::BaseModel
+          attr_accessor count: Integer
+
+          attr_accessor type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_
+
+          attr_reader sort_key: String?
+
+          def sort_key=: (String) -> String
+
+          def initialize: (
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            ?sort_key: String
+          ) -> void
+
+          def to_hash: -> {
+            count: Integer,
+            type: Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_,
+            sort_key: String
+          }
+
+          type type_ = :first | :last | :highest | :lowest
+
+          module Type
+            extend Courier::Internal::Type::Enum
+
+            FIRST: :first
+            LAST: :last
+            HIGHEST: :highest
+            LOWEST: :lowest
+
+            def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::Retain::type_]
+          end
+        end
+
+        type scope = :user
+
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          USER: :user
+
+          def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::scope]
+        end
+
+        type type_ = :batch
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          BATCH: :batch
+
+          def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBatchNode::type_]
+        end
+      end
+
+      type journey_branch_node =
+        {
+          default: Courier::JourneyNode::JourneyBranchNode::Default,
+          paths: ::Array[Courier::JourneyNode::JourneyBranchNode::Path],
+          type: Courier::Models::JourneyNode::JourneyBranchNode::type_,
+          id: String
+        }
+
+      class JourneyBranchNode < Courier::Internal::Type::BaseModel
+        attr_accessor default: Courier::JourneyNode::JourneyBranchNode::Default
+
+        attr_accessor paths: ::Array[Courier::JourneyNode::JourneyBranchNode::Path]
+
+        attr_accessor type: Courier::Models::JourneyNode::JourneyBranchNode::type_
+
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        def initialize: (
+          default: Courier::JourneyNode::JourneyBranchNode::Default,
+          paths: ::Array[Courier::JourneyNode::JourneyBranchNode::Path],
+          type: Courier::Models::JourneyNode::JourneyBranchNode::type_,
+          ?id: String
+        ) -> void
+
+        def to_hash: -> {
+          default: Courier::JourneyNode::JourneyBranchNode::Default,
+          paths: ::Array[Courier::JourneyNode::JourneyBranchNode::Path],
+          type: Courier::Models::JourneyNode::JourneyBranchNode::type_,
+          id: String
+        }
+
+        type default =
+          { nodes: ::Array[Courier::Models::journey_node], label: String }
+
+        class Default < Courier::Internal::Type::BaseModel
+          attr_accessor nodes: ::Array[Courier::Models::journey_node]
+
+          attr_reader label: String?
+
+          def label=: (String) -> String
+
+          def initialize: (
+            nodes: ::Array[Courier::Models::journey_node],
+            ?label: String
+          ) -> void
+
+          def to_hash: -> {
+            nodes: ::Array[Courier::Models::journey_node],
+            label: String
+          }
+        end
+
+        type path =
+          {
+            conditions: Courier::Models::journey_conditions_field,
+            nodes: ::Array[Courier::Models::journey_node],
+            label: String
+          }
+
+        class Path < Courier::Internal::Type::BaseModel
+          attr_accessor conditions: Courier::Models::journey_conditions_field
+
+          attr_accessor nodes: ::Array[Courier::Models::journey_node]
+
+          attr_reader label: String?
+
+          def label=: (String) -> String
+
+          def initialize: (
+            conditions: Courier::Models::journey_conditions_field,
+            nodes: ::Array[Courier::Models::journey_node],
+            ?label: String
+          ) -> void
+
+          def to_hash: -> {
+            conditions: Courier::Models::journey_conditions_field,
+            nodes: ::Array[Courier::Models::journey_node],
+            label: String
+          }
+        end
+
+        type type_ = :branch
+
+        module Type
+          extend Courier::Internal::Type::Enum
+
+          BRANCH: :branch
+
+          def self?.values: -> ::Array[Courier::Models::JourneyNode::JourneyBranchNode::type_]
+        end
+      end
+
+      def self?.variants: -> ::Array[Courier::Models::journey_node]
+    end
+  end
+end

data/sig/courier/models/journey_publish_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type journey_publish_params =
+      { template_id: String } & Courier::Internal::Type::request_parameters
+
+    class JourneyPublishParams < Courier::Models::JourneyPublishRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def template_id: -> String
+
+      def template_id=: (String _) -> String
+
+      def initialize: (
+        template_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        template_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/journey_publish_request.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type journey_publish_request = { version: String }
+
+    class JourneyPublishRequest < Courier::Internal::Type::BaseModel
+      attr_reader version: String?
+
+      def version=: (String) -> String
+
+      def initialize: (?version: String) -> void
+
+      def to_hash: -> { version: String }
+    end
+  end
+end

data/sig/courier/models/journey_replace_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type journey_replace_params =
+      { template_id: String } & Courier::Internal::Type::request_parameters
+
+    class JourneyReplaceParams < Courier::Models::CreateJourneyRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def template_id: -> String
+
+      def template_id=: (String _) -> String
+
+      def initialize: (
+        template_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        template_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/journey_response.rbs

@@ -0,0 +1,65 @@
+module Courier
+  module Models
+    type journey_response =
+      {
+        id: String,
+        created: Integer?,
+        creator: String?,
+        enabled: bool,
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        published: Integer?,
+        state: Courier::Models::journey_state,
+        updated: Integer?,
+        updater: String?
+      }
+
+    class JourneyResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created: Integer?
+
+      attr_accessor creator: String?
+
+      attr_accessor enabled: bool
+
+      attr_accessor name: String
+
+      attr_accessor nodes: ::Array[Courier::Models::journey_node]
+
+      attr_accessor published: Integer?
+
+      attr_accessor state: Courier::Models::journey_state
+
+      attr_accessor updated: Integer?
+
+      attr_accessor updater: String?
+
+      def initialize: (
+        id: String,
+        created: Integer?,
+        creator: String?,
+        enabled: bool,
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        published: Integer?,
+        state: Courier::Models::journey_state,
+        updated: Integer?,
+        updater: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created: Integer?,
+        creator: String?,
+        enabled: bool,
+        name: String,
+        nodes: ::Array[Courier::Models::journey_node],
+        published: Integer?,
+        state: Courier::Models::journey_state,
+        updated: Integer?,
+        updater: String?
+      }
+    end
+  end
+end

data/sig/courier/models/journey_retrieve_params.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type journey_retrieve_params =
+      { template_id: String, version: String }
+      & Courier::Internal::Type::request_parameters
+
+    class JourneyRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor template_id: String
+
+      attr_reader version: String?
+
+      def version=: (String) -> String
+
+      def initialize: (
+        template_id: String,
+        ?version: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        template_id: String,
+        version: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/journey_segment_trigger_node.rbs

@@ -0,0 +1,85 @@
+module Courier
+  module Models
+    type journey_segment_trigger_node =
+      {
+        request_type: Courier::Models::JourneySegmentTriggerNode::request_type,
+        trigger_type: Courier::Models::JourneySegmentTriggerNode::trigger_type,
+        type: Courier::Models::JourneySegmentTriggerNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        event_id: String
+      }
+
+    class JourneySegmentTriggerNode < Courier::Internal::Type::BaseModel
+      attr_accessor request_type: Courier::Models::JourneySegmentTriggerNode::request_type
+
+      attr_accessor trigger_type: Courier::Models::JourneySegmentTriggerNode::trigger_type
+
+      attr_accessor type: Courier::Models::JourneySegmentTriggerNode::type_
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader conditions: Courier::Models::journey_conditions_field?
+
+      def conditions=: (
+        Courier::Models::journey_conditions_field
+      ) -> Courier::Models::journey_conditions_field
+
+      attr_reader event_id: String?
+
+      def event_id=: (String) -> String
+
+      def initialize: (
+        request_type: Courier::Models::JourneySegmentTriggerNode::request_type,
+        trigger_type: Courier::Models::JourneySegmentTriggerNode::trigger_type,
+        type: Courier::Models::JourneySegmentTriggerNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field,
+        ?event_id: String
+      ) -> void
+
+      def to_hash: -> {
+        request_type: Courier::Models::JourneySegmentTriggerNode::request_type,
+        trigger_type: Courier::Models::JourneySegmentTriggerNode::trigger_type,
+        type: Courier::Models::JourneySegmentTriggerNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field,
+        event_id: String
+      }
+
+      type request_type = :identify | :group | :track
+
+      module RequestType
+        extend Courier::Internal::Type::Enum
+
+        IDENTIFY: :identify
+        GROUP: :group
+        TRACK: :track
+
+        def self?.values: -> ::Array[Courier::Models::JourneySegmentTriggerNode::request_type]
+      end
+
+      type trigger_type = :segment
+
+      module TriggerType
+        extend Courier::Internal::Type::Enum
+
+        SEGMENT: :segment
+
+        def self?.values: -> ::Array[Courier::Models::JourneySegmentTriggerNode::trigger_type]
+      end
+
+      type type_ = :trigger
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TRIGGER: :trigger
+
+        def self?.values: -> ::Array[Courier::Models::JourneySegmentTriggerNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_send_node.rbs

@@ -0,0 +1,140 @@
+module Courier
+  module Models
+    type journey_send_node =
+      {
+        message: Courier::JourneySendNode::Message,
+        type: Courier::Models::JourneySendNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+    class JourneySendNode < Courier::Internal::Type::BaseModel
+      attr_accessor message: Courier::JourneySendNode::Message
+
+      attr_accessor type: Courier::Models::JourneySendNode::type_
+
+      attr_reader id: String?
+
+      def id=: (String) -> String
+
+      attr_reader conditions: Courier::Models::journey_conditions_field?
+
+      def conditions=: (
+        Courier::Models::journey_conditions_field
+      ) -> Courier::Models::journey_conditions_field
+
+      def initialize: (
+        message: Courier::JourneySendNode::Message,
+        type: Courier::Models::JourneySendNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field
+      ) -> void
+
+      def to_hash: -> {
+        message: Courier::JourneySendNode::Message,
+        type: Courier::Models::JourneySendNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+      type message =
+        {
+          template: String,
+          data: ::Hash[Symbol, top],
+          delay: Courier::JourneySendNode::Message::Delay,
+          to: Courier::JourneySendNode::Message::To
+        }
+
+      class Message < Courier::Internal::Type::BaseModel
+        attr_accessor template: String
+
+        attr_reader data: ::Hash[Symbol, top]?
+
+        def data=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader delay: Courier::JourneySendNode::Message::Delay?
+
+        def delay=: (
+          Courier::JourneySendNode::Message::Delay
+        ) -> Courier::JourneySendNode::Message::Delay
+
+        attr_reader to: Courier::JourneySendNode::Message::To?
+
+        def to=: (
+          Courier::JourneySendNode::Message::To
+        ) -> Courier::JourneySendNode::Message::To
+
+        def initialize: (
+          template: String,
+          ?data: ::Hash[Symbol, top],
+          ?delay: Courier::JourneySendNode::Message::Delay,
+          ?to: Courier::JourneySendNode::Message::To
+        ) -> void
+
+        def to_hash: -> {
+          template: String,
+          data: ::Hash[Symbol, top],
+          delay: Courier::JourneySendNode::Message::Delay,
+          to: Courier::JourneySendNode::Message::To
+        }
+
+        type delay = { until_: String, timezone: String }
+
+        class Delay < Courier::Internal::Type::BaseModel
+          attr_accessor until_: String
+
+          attr_reader timezone: String?
+
+          def timezone=: (String) -> String
+
+          def initialize: (until_: String, ?timezone: String) -> void
+
+          def to_hash: -> { until_: String, timezone: String }
+        end
+
+        type to =
+          {
+            email_override: String,
+            phone_number_override: String,
+            user_id_override: String
+          }
+
+        class To < Courier::Internal::Type::BaseModel
+          attr_reader email_override: String?
+
+          def email_override=: (String) -> String
+
+          attr_reader phone_number_override: String?
+
+          def phone_number_override=: (String) -> String
+
+          attr_reader user_id_override: String?
+
+          def user_id_override=: (String) -> String
+
+          def initialize: (
+            ?email_override: String,
+            ?phone_number_override: String,
+            ?user_id_override: String
+          ) -> void
+
+          def to_hash: -> {
+            email_override: String,
+            phone_number_override: String,
+            user_id_override: String
+          }
+        end
+      end
+
+      type type_ = :send
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        SEND: :send
+
+        def self?.values: -> ::Array[Courier::Models::JourneySendNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_state.rbs

@@ -0,0 +1,14 @@
+module Courier
+  module Models
+    type journey_state = :DRAFT | :PUBLISHED
+
+    module JourneyState
+      extend Courier::Internal::Type::Enum
+
+      DRAFT: :DRAFT
+      PUBLISHED: :PUBLISHED
+
+      def self?.values: -> ::Array[Courier::Models::journey_state]
+    end
+  end
+end