trycourier 4.10.2 → 4.11.0

data/sig/courier/models/journey_template_replace_request.rbs

@@ -0,0 +1,136 @@
+module Courier
+  module Models
+    type journey_template_replace_request =
+      {
+        notification: Courier::JourneyTemplateReplaceRequest::Notification,
+        state: String
+      }
+
+    class JourneyTemplateReplaceRequest < Courier::Internal::Type::BaseModel
+      attr_accessor notification: Courier::JourneyTemplateReplaceRequest::Notification
+
+      attr_reader state: String?
+
+      def state=: (String) -> String
+
+      def initialize: (
+        notification: Courier::JourneyTemplateReplaceRequest::Notification,
+        ?state: String
+      ) -> void
+
+      def to_hash: -> {
+        notification: Courier::JourneyTemplateReplaceRequest::Notification,
+        state: String
+      }
+
+      type notification =
+        {
+          brand: Courier::JourneyTemplateReplaceRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateReplaceRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateReplaceRequest::Notification::Subscription?,
+          tags: ::Array[String]
+        }
+
+      class Notification < Courier::Internal::Type::BaseModel
+        attr_accessor brand: Courier::JourneyTemplateReplaceRequest::Notification::Brand?
+
+        attr_accessor content: Courier::JourneyTemplateReplaceRequest::Notification::Content
+
+        attr_accessor name: String
+
+        attr_accessor subscription: Courier::JourneyTemplateReplaceRequest::Notification::Subscription?
+
+        attr_accessor tags: ::Array[String]
+
+        def initialize: (
+          brand: Courier::JourneyTemplateReplaceRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateReplaceRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateReplaceRequest::Notification::Subscription?,
+          tags: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          brand: Courier::JourneyTemplateReplaceRequest::Notification::Brand?,
+          content: Courier::JourneyTemplateReplaceRequest::Notification::Content,
+          name: String,
+          subscription: Courier::JourneyTemplateReplaceRequest::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::JourneyTemplateReplaceRequest::Notification::Content::version,
+            scope: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::scope
+          }
+
+        class Content < Courier::Internal::Type::BaseModel
+          attr_accessor elements: ::Array[Courier::Models::elemental_node]
+
+          attr_accessor version: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::version
+
+          attr_reader scope: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::scope?
+
+          def scope=: (
+            Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::scope
+          ) -> Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::scope
+
+          def initialize: (
+            elements: ::Array[Courier::Models::elemental_node],
+            version: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::version,
+            ?scope: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::scope
+          ) -> void
+
+          def to_hash: -> {
+            elements: ::Array[Courier::Models::elemental_node],
+            version: Courier::Models::JourneyTemplateReplaceRequest::Notification::Content::version,
+            scope: Courier::Models::JourneyTemplateReplaceRequest::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::JourneyTemplateReplaceRequest::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::JourneyTemplateReplaceRequest::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_summary.rbs

@@ -0,0 +1,59 @@
+module Courier
+  module Models
+    type journey_template_summary =
+      {
+        id: String,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: String,
+        tags: ::Array[String],
+        updated: Integer,
+        updater: String
+      }
+
+    class JourneyTemplateSummary < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created: Integer
+
+      attr_accessor creator: String
+
+      attr_accessor name: String
+
+      attr_accessor state: String
+
+      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,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: String,
+        tags: ::Array[String],
+        ?updated: Integer,
+        ?updater: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created: Integer,
+        creator: String,
+        name: String,
+        state: String,
+        tags: ::Array[String],
+        updated: Integer,
+        updater: String
+      }
+    end
+  end
+end

data/sig/courier/models/journey_throttle_dynamic_node.rbs

@@ -0,0 +1,76 @@
+module Courier
+  module Models
+    type journey_throttle_dynamic_node =
+      {
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleDynamicNode::scope,
+        throttle_key: String,
+        type: Courier::Models::JourneyThrottleDynamicNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+    class JourneyThrottleDynamicNode < Courier::Internal::Type::BaseModel
+      attr_accessor max_allowed: Integer
+
+      attr_accessor period: String
+
+      attr_accessor scope: Courier::Models::JourneyThrottleDynamicNode::scope
+
+      attr_accessor throttle_key: String
+
+      attr_accessor type: Courier::Models::JourneyThrottleDynamicNode::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: (
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleDynamicNode::scope,
+        throttle_key: String,
+        type: Courier::Models::JourneyThrottleDynamicNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field
+      ) -> void
+
+      def to_hash: -> {
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleDynamicNode::scope,
+        throttle_key: String,
+        type: Courier::Models::JourneyThrottleDynamicNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+      type scope = :dynamic
+
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        DYNAMIC: :dynamic
+
+        def self?.values: -> ::Array[Courier::Models::JourneyThrottleDynamicNode::scope]
+      end
+
+      type type_ = :throttle
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE: :throttle
+
+        def self?.values: -> ::Array[Courier::Models::JourneyThrottleDynamicNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_throttle_static_node.rbs

@@ -0,0 +1,72 @@
+module Courier
+  module Models
+    type journey_throttle_static_node =
+      {
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleStaticNode::scope,
+        type: Courier::Models::JourneyThrottleStaticNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+    class JourneyThrottleStaticNode < Courier::Internal::Type::BaseModel
+      attr_accessor max_allowed: Integer
+
+      attr_accessor period: String
+
+      attr_accessor scope: Courier::Models::JourneyThrottleStaticNode::scope
+
+      attr_accessor type: Courier::Models::JourneyThrottleStaticNode::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: (
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleStaticNode::scope,
+        type: Courier::Models::JourneyThrottleStaticNode::type_,
+        ?id: String,
+        ?conditions: Courier::Models::journey_conditions_field
+      ) -> void
+
+      def to_hash: -> {
+        max_allowed: Integer,
+        period: String,
+        scope: Courier::Models::JourneyThrottleStaticNode::scope,
+        type: Courier::Models::JourneyThrottleStaticNode::type_,
+        id: String,
+        conditions: Courier::Models::journey_conditions_field
+      }
+
+      type scope = :user | :global
+
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        USER: :user
+        GLOBAL: :global
+
+        def self?.values: -> ::Array[Courier::Models::JourneyThrottleStaticNode::scope]
+      end
+
+      type type_ = :throttle
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE: :throttle
+
+        def self?.values: -> ::Array[Courier::Models::JourneyThrottleStaticNode::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/journey_version_item.rbs

@@ -0,0 +1,40 @@
+module Courier
+  module Models
+    type journey_version_item =
+      {
+        created: Integer?,
+        creator: String?,
+        name: String,
+        published: Integer?,
+        version: String
+      }
+
+    class JourneyVersionItem < Courier::Internal::Type::BaseModel
+      attr_accessor created: Integer?
+
+      attr_accessor creator: String?
+
+      attr_accessor name: String
+
+      attr_accessor published: Integer?
+
+      attr_accessor version: String
+
+      def initialize: (
+        created: Integer?,
+        creator: String?,
+        name: String,
+        published: Integer?,
+        version: String
+      ) -> void
+
+      def to_hash: -> {
+        created: Integer?,
+        creator: String?,
+        name: String,
+        published: Integer?,
+        version: String
+      }
+    end
+  end
+end

data/sig/courier/models/journey_versions_list_response.rbs

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

data/sig/courier/models/journeys/template_archive_params.rbs

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

data/sig/courier/models/journeys/template_create_params.rbs

@@ -0,0 +1,27 @@
+module Courier
+  module Models
+    module Journeys
+      type template_create_params =
+        { template_id: String } & Courier::Internal::Type::request_parameters
+
+      class TemplateCreateParams < Courier::Models::JourneyTemplateCreateRequest
+        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
+end

data/sig/courier/models/journeys/template_list_params.rbs

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

data/sig/courier/models/journeys/template_list_versions_params.rbs

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

data/sig/courier/models/journeys/template_publish_params.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    module Journeys
+      type template_publish_params =
+        { template_id: String, notification_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TemplatePublishParams < Courier::Models::JourneyTemplatePublishRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def template_id: -> String
+
+        def template_id=: (String _) -> String
+
+        def notification_id: -> String
+
+        def notification_id=: (String _) -> String
+
+        def initialize: (
+          template_id: String,
+          notification_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          template_id: String,
+          notification_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/journeys/template_replace_params.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    module Journeys
+      type template_replace_params =
+        { template_id: String, notification_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TemplateReplaceParams < Courier::Models::JourneyTemplateReplaceRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def template_id: -> String
+
+        def template_id=: (String _) -> String
+
+        def notification_id: -> String
+
+        def notification_id=: (String _) -> String
+
+        def initialize: (
+          template_id: String,
+          notification_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          template_id: String,
+          notification_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/journeys/template_retrieve_params.rbs

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

data/sig/courier/models/tenants/template_delete_params.rbs

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