trycourier 4.10.2 → 4.11.0

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

data/sig/courier/models/journey_template_create_request.rbs

@@ -0,0 +1,148 @@
+module Courier
+  module Models
+    type journey_template_create_request =
+      {
+        channel: String,
+        notification: Courier::JourneyTemplateCreateRequest::Notification,
+        provider_key: String,
+        state: String
+      }
+
+    class JourneyTemplateCreateRequest < Courier::Internal::Type::BaseModel
+      attr_accessor channel: String
+
+      attr_accessor notification: Courier::JourneyTemplateCreateRequest::Notification
+
+      attr_reader provider_key: String?
+
+      def provider_key=: (String) -> String
+
+      attr_reader state: String?
+
+      def state=: (String) -> String
+
+      def initialize: (
+        channel: String,
+        notification: Courier::JourneyTemplateCreateRequest::Notification,
+        ?provider_key: String,
+        ?state: String
+      ) -> void
+
+      def to_hash: -> {
+        channel: String,
+        notification: Courier::JourneyTemplateCreateRequest::Notification,
+        provider_key: String,
+        state: String
+      }
+
+      type notification =
+        {
+          brand: Courier::JourneyTemplateCreateRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateCreateRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateCreateRequest::Notification::Subscription?,
+          tags: ::Array[String]
+        }
+
+      class Notification < Courier::Internal::Type::BaseModel
+        attr_accessor brand: Courier::JourneyTemplateCreateRequest::Notification::Brand?
+
+        attr_accessor content: Courier::JourneyTemplateCreateRequest::Notification::Content
+
+        attr_accessor name: String
+
+        attr_accessor subscription: Courier::JourneyTemplateCreateRequest::Notification::Subscription?
+
+        attr_accessor tags: ::Array[String]
+
+        def initialize: (
+          brand: Courier::JourneyTemplateCreateRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateCreateRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateCreateRequest::Notification::Subscription?,
+          tags: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          brand: Courier::JourneyTemplateCreateRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateCreateRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateCreateRequest::Notification::Subscription?,
+          tags: ::Array[String]
+        }
+
+        type brand = { id: String }
+
+        class Brand < Courier::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          def initialize: (id: String) -> void
+
+          def to_hash: -> { id: String }
+        end
+
+        type content =
+          {
+            elements: ::Array[Courier::Models::elemental_node],
+            version: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::version,
+            scope: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope
+          }
+
+        class Content < Courier::Internal::Type::BaseModel
+          attr_accessor elements: ::Array[Courier::Models::elemental_node]
+
+          attr_accessor version: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::version
+
+          attr_reader scope: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope?
+
+          def scope=: (
+            Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope
+          ) -> Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope
+
+          def initialize: (
+            elements: ::Array[Courier::Models::elemental_node],
+            version: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::version,
+            ?scope: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope
+          ) -> void
+
+          def to_hash: -> {
+            elements: ::Array[Courier::Models::elemental_node],
+            version: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::version,
+            scope: Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope
+          }
+
+          type version = :"2022-01-01"
+
+          module Version
+            extend Courier::Internal::Type::Enum
+
+            VERSION_2022_01_01: :"2022-01-01"
+
+            def self?.values: -> ::Array[Courier::Models::JourneyTemplateCreateRequest::Notification::Content::version]
+          end
+
+          type scope = :default | :strict
+
+          module Scope
+            extend Courier::Internal::Type::Enum
+
+            DEFAULT: :default
+            STRICT: :strict
+
+            def self?.values: -> ::Array[Courier::Models::JourneyTemplateCreateRequest::Notification::Content::scope]
+          end
+        end
+
+        type subscription = { topic_id: String }
+
+        class Subscription < Courier::Internal::Type::BaseModel
+          attr_accessor topic_id: String
+
+          def initialize: (topic_id: String) -> void
+
+          def to_hash: -> { topic_id: String }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/journey_template_get_response.rbs

@@ -0,0 +1,157 @@
+module Courier
+  module Models
+    type journey_template_get_response =
+      {
+        id: String,
+        brand: Courier::JourneyTemplateGetResponse::Brand?,
+        content: Courier::JourneyTemplateGetResponse::Content,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: Courier::Models::JourneyTemplateGetResponse::state,
+        subscription: Courier::JourneyTemplateGetResponse::Subscription?,
+        tags: ::Array[String],
+        updated: Integer,
+        updater: String
+      }
+
+    class JourneyTemplateGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor brand: Courier::JourneyTemplateGetResponse::Brand?
+
+      attr_accessor content: Courier::JourneyTemplateGetResponse::Content
+
+      attr_accessor created: Integer
+
+      attr_accessor creator: String
+
+      attr_accessor name: String
+
+      attr_accessor state: Courier::Models::JourneyTemplateGetResponse::state
+
+      attr_accessor subscription: Courier::JourneyTemplateGetResponse::Subscription?
+
+      attr_accessor tags: ::Array[String]
+
+      attr_reader updated: Integer?
+
+      def updated=: (Integer) -> Integer
+
+      attr_reader updater: String?
+
+      def updater=: (String) -> String
+
+      def initialize: (
+        id: String,
+        brand: Courier::JourneyTemplateGetResponse::Brand?,
+        content: Courier::JourneyTemplateGetResponse::Content,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: Courier::Models::JourneyTemplateGetResponse::state,
+        subscription: Courier::JourneyTemplateGetResponse::Subscription?,
+        tags: ::Array[String],
+        ?updated: Integer,
+        ?updater: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        brand: Courier::JourneyTemplateGetResponse::Brand?,
+        content: Courier::JourneyTemplateGetResponse::Content,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: Courier::Models::JourneyTemplateGetResponse::state,
+        subscription: Courier::JourneyTemplateGetResponse::Subscription?,
+        tags: ::Array[String],
+        updated: Integer,
+        updater: String
+      }
+
+      type brand = { id: String }
+
+      class Brand < Courier::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> { id: String }
+      end
+
+      type content =
+        {
+          elements: ::Array[Courier::Models::elemental_node],
+          version: Courier::Models::JourneyTemplateGetResponse::Content::version,
+          scope: Courier::Models::JourneyTemplateGetResponse::Content::scope
+        }
+
+      class Content < Courier::Internal::Type::BaseModel
+        attr_accessor elements: ::Array[Courier::Models::elemental_node]
+
+        attr_accessor version: Courier::Models::JourneyTemplateGetResponse::Content::version
+
+        attr_reader scope: Courier::Models::JourneyTemplateGetResponse::Content::scope?
+
+        def scope=: (
+          Courier::Models::JourneyTemplateGetResponse::Content::scope
+        ) -> Courier::Models::JourneyTemplateGetResponse::Content::scope
+
+        def initialize: (
+          elements: ::Array[Courier::Models::elemental_node],
+          version: Courier::Models::JourneyTemplateGetResponse::Content::version,
+          ?scope: Courier::Models::JourneyTemplateGetResponse::Content::scope
+        ) -> void
+
+        def to_hash: -> {
+          elements: ::Array[Courier::Models::elemental_node],
+          version: Courier::Models::JourneyTemplateGetResponse::Content::version,
+          scope: Courier::Models::JourneyTemplateGetResponse::Content::scope
+        }
+
+        type version = :"2022-01-01"
+
+        module Version
+          extend Courier::Internal::Type::Enum
+
+          VERSION_2022_01_01: :"2022-01-01"
+
+          def self?.values: -> ::Array[Courier::Models::JourneyTemplateGetResponse::Content::version]
+        end
+
+        type scope = :default | :strict
+
+        module Scope
+          extend Courier::Internal::Type::Enum
+
+          DEFAULT: :default
+          STRICT: :strict
+
+          def self?.values: -> ::Array[Courier::Models::JourneyTemplateGetResponse::Content::scope]
+        end
+      end
+
+      type state = :DRAFT | :PUBLISHED
+
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT: :DRAFT
+        PUBLISHED: :PUBLISHED
+
+        def self?.values: -> ::Array[Courier::Models::JourneyTemplateGetResponse::state]
+      end
+
+      type subscription = { topic_id: String }
+
+      class Subscription < Courier::Internal::Type::BaseModel
+        attr_accessor topic_id: String
+
+        def initialize: (topic_id: String) -> void
+
+        def to_hash: -> { topic_id: String }
+      end
+    end
+  end
+end

data/sig/courier/models/journey_template_list_response.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type journey_template_list_response =
+      {
+        paging: Courier::Paging,
+        results: ::Array[Courier::JourneyTemplateSummary]
+      }
+
+    class JourneyTemplateListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor paging: Courier::Paging
+
+      attr_accessor results: ::Array[Courier::JourneyTemplateSummary]
+
+      def initialize: (
+        paging: Courier::Paging,
+        results: ::Array[Courier::JourneyTemplateSummary]
+      ) -> void
+
+      def to_hash: -> {
+        paging: Courier::Paging,
+        results: ::Array[Courier::JourneyTemplateSummary]
+      }
+    end
+  end
+end

data/sig/courier/models/journey_template_publish_request.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type journey_template_publish_request = { version: String }
+
+    class JourneyTemplatePublishRequest < 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