trycourier 4.8.0 → 4.10.0

data/lib/courier/models/routing_strategy_summary.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class RoutingStrategySummary < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The routing strategy ID (rs\_ prefix).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Epoch milliseconds when the strategy was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #   Description of the routing strategy.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute tags
+      #   Tags for categorization.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer, nil?: true
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String, nil?: true
+
+      # @!method initialize(id:, created:, creator:, name:, description: nil, tags: nil, updated: nil, updater: nil)
+      #   Routing strategy metadata returned in list responses. Does not include
+      #   routing/channels/providers content.
+      #
+      #   @param id [String] The routing strategy ID (rs\_ prefix).
+      #
+      #   @param created [Integer] Epoch milliseconds when the strategy was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param description [String, nil] Description of the routing strategy.
+      #
+      #   @param tags [Array<String>, nil] Tags for categorization.
+      #
+      #   @param updated [Integer, nil] Epoch milliseconds of last update.
+      #
+      #   @param updater [String, nil] User ID of the last updater.
+    end
+  end
+end

data/lib/courier/models/send_message_params.rb

@@ -32,10 +32,8 @@ module Courier
         #   Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
         #   inbox, direct_message, banner, webhook.
         #
-        #   @return [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Channel}, nil]
-        optional :channels,
-                 -> { Courier::Internal::Type::HashOf[Courier::SendMessageParams::Message::Channel] },
-                 nil?: true
+        #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+        optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }, nil?: true
 
         # @!attribute content
         #   Describes content that will work for email, inbox, push, chat, or any channel
@@ -76,10 +74,8 @@ module Courier
 
         # @!attribute providers
         #
-        #   @return [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Provider}, nil]
-        optional :providers,
-                 -> { Courier::Internal::Type::HashOf[Courier::SendMessageParams::Message::Provider] },
-                 nil?: true
+        #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+        optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }, nil?: true
 
         # @!attribute routing
         #   Customize which channels/providers Courier may deliver the message through.
@@ -112,7 +108,7 @@ module Courier
         #
         #   @param brand_id [String, nil]
         #
-        #   @param channels [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Channel}, nil] Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
+        #   @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
         #
         #   @param content [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent] Describes content that will work for email, inbox, push, chat, or any channel id
         #
@@ -128,7 +124,7 @@ module Courier
         #
         #   @param preferences [Courier::Models::SendMessageParams::Message::Preferences, nil]
         #
-        #   @param providers [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Provider}, nil]
+        #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
         #
         #   @param routing [Courier::Models::SendMessageParams::Message::Routing, nil] Customize which channels/providers Courier may deliver the message through.
         #
@@ -138,106 +134,6 @@ module Courier
         #
         #   @param to [Courier::Models::UserRecipient, Courier::Models::AudienceRecipient, Courier::Models::ListRecipient, Courier::Models::ListPatternRecipient, Courier::Models::SlackRecipient, Courier::Models::MsTeamsRecipient, Courier::Models::PagerdutyRecipient, Courier::Models::WebhookRecipient, Array<Courier::Models::UserRecipient, Courier::Models::AudienceRecipient, Courier::Models::ListRecipient, Courier::Models::ListPatternRecipient, Courier::Models::SlackRecipient, Courier::Models::MsTeamsRecipient, Courier::Models::PagerdutyRecipient, Courier::Models::WebhookRecipient>, nil] The recipient or a list of recipients of the message
 
-        class Channel < Courier::Internal::Type::BaseModel
-          # @!attribute brand_id
-          #   Brand id used for rendering.
-          #
-          #   @return [String, nil]
-          optional :brand_id, String, nil?: true
-
-          # @!attribute if_
-          #   JS conditional with access to data/profile.
-          #
-          #   @return [String, nil]
-          optional :if_, String, api_name: :if, nil?: true
-
-          # @!attribute metadata
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Channel::Metadata, nil]
-          optional :metadata, -> { Courier::SendMessageParams::Message::Channel::Metadata }, nil?: true
-
-          # @!attribute override
-          #   Channel specific overrides.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-          # @!attribute providers
-          #   Providers enabled for this channel.
-          #
-          #   @return [Array<String>, nil]
-          optional :providers, Courier::Internal::Type::ArrayOf[String], nil?: true
-
-          # @!attribute routing_method
-          #   Defaults to `single`.
-          #
-          #   @return [Symbol, Courier::Models::SendMessageParams::Message::Channel::RoutingMethod, nil]
-          optional :routing_method,
-                   enum: -> { Courier::SendMessageParams::Message::Channel::RoutingMethod },
-                   nil?: true
-
-          # @!attribute timeouts
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Channel::Timeouts, nil]
-          optional :timeouts, -> { Courier::SendMessageParams::Message::Channel::Timeouts }, nil?: true
-
-          # @!method initialize(brand_id: nil, if_: nil, metadata: nil, override: nil, providers: nil, routing_method: nil, timeouts: nil)
-          #   @param brand_id [String, nil] Brand id used for rendering.
-          #
-          #   @param if_ [String, nil] JS conditional with access to data/profile.
-          #
-          #   @param metadata [Courier::Models::SendMessageParams::Message::Channel::Metadata, nil]
-          #
-          #   @param override [Hash{Symbol=>Object}, nil] Channel specific overrides.
-          #
-          #   @param providers [Array<String>, nil] Providers enabled for this channel.
-          #
-          #   @param routing_method [Symbol, Courier::Models::SendMessageParams::Message::Channel::RoutingMethod, nil] Defaults to `single`.
-          #
-          #   @param timeouts [Courier::Models::SendMessageParams::Message::Channel::Timeouts, nil]
-
-          # @see Courier::Models::SendMessageParams::Message::Channel#metadata
-          class Metadata < Courier::Internal::Type::BaseModel
-            # @!attribute utm
-            #
-            #   @return [Courier::Models::Utm, nil]
-            optional :utm, -> { Courier::Utm }, nil?: true
-
-            # @!method initialize(utm: nil)
-            #   @param utm [Courier::Models::Utm, nil]
-          end
-
-          # Defaults to `single`.
-          #
-          # @see Courier::Models::SendMessageParams::Message::Channel#routing_method
-          module RoutingMethod
-            extend Courier::Internal::Type::Enum
-
-            ALL = :all
-            SINGLE = :single
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # @see Courier::Models::SendMessageParams::Message::Channel#timeouts
-          class Timeouts < Courier::Internal::Type::BaseModel
-            # @!attribute channel
-            #
-            #   @return [Integer, nil]
-            optional :channel, Integer, nil?: true
-
-            # @!attribute provider
-            #
-            #   @return [Integer, nil]
-            optional :provider, Integer, nil?: true
-
-            # @!method initialize(channel: nil, provider: nil)
-            #   @param channel [Integer, nil]
-            #   @param provider [Integer, nil]
-          end
-        end
-
         # Describes content that will work for email, inbox, push, chat, or any channel
         # id.
         #
@@ -362,50 +258,6 @@ module Courier
           #   @param subscription_topic_id [String] The subscription topic to apply to the message.
         end
 
-        class Provider < Courier::Internal::Type::BaseModel
-          # @!attribute if_
-          #   JS conditional with access to data/profile.
-          #
-          #   @return [String, nil]
-          optional :if_, String, api_name: :if, nil?: true
-
-          # @!attribute metadata
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Provider::Metadata, nil]
-          optional :metadata, -> { Courier::SendMessageParams::Message::Provider::Metadata }, nil?: true
-
-          # @!attribute override
-          #   Provider-specific overrides.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-          # @!attribute timeouts
-          #
-          #   @return [Integer, nil]
-          optional :timeouts, Integer, nil?: true
-
-          # @!method initialize(if_: nil, metadata: nil, override: nil, timeouts: nil)
-          #   @param if_ [String, nil] JS conditional with access to data/profile.
-          #
-          #   @param metadata [Courier::Models::SendMessageParams::Message::Provider::Metadata, nil]
-          #
-          #   @param override [Hash{Symbol=>Object}, nil] Provider-specific overrides.
-          #
-          #   @param timeouts [Integer, nil]
-
-          # @see Courier::Models::SendMessageParams::Message::Provider#metadata
-          class Metadata < Courier::Internal::Type::BaseModel
-            # @!attribute utm
-            #
-            #   @return [Courier::Models::Utm, nil]
-            optional :utm, -> { Courier::Utm }, nil?: true
-
-            # @!method initialize(utm: nil)
-            #   @param utm [Courier::Models::Utm, nil]
-          end
-        end
-
         # @see Courier::Models::SendMessageParams::Message#routing
         class Routing < Courier::Internal::Type::BaseModel
           # @!attribute channels

data/lib/courier/models/tenant_template_input.rb

@@ -12,15 +12,15 @@ module Courier
       # @!attribute channels
       #   Channel-specific delivery configuration (email, SMS, push, etc.)
       #
-      #   @return [Hash{Symbol=>Courier::Models::TenantTemplateInput::Channel}, nil]
-      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::TenantTemplateInput::Channel] }
+      #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }
 
       # @!attribute providers
       #   Provider-specific delivery configuration for routing to specific email/SMS
       #   providers
       #
-      #   @return [Hash{Symbol=>Courier::Models::TenantTemplateInput::Provider}, nil]
-      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::TenantTemplateInput::Provider] }
+      #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }
 
       # @!attribute routing
       #   Message routing configuration for multi-channel delivery strategies
@@ -36,157 +36,11 @@ module Courier
       #
       #   @param content [Courier::Models::ElementalContent] Template content configuration including blocks, elements, and message structure
       #
-      #   @param channels [Hash{Symbol=>Courier::Models::TenantTemplateInput::Channel}] Channel-specific delivery configuration (email, SMS, push, etc.)
+      #   @param channels [Hash{Symbol=>Courier::Models::Channel}] Channel-specific delivery configuration (email, SMS, push, etc.)
       #
-      #   @param providers [Hash{Symbol=>Courier::Models::TenantTemplateInput::Provider}] Provider-specific delivery configuration for routing to specific email/SMS provi
+      #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}] Provider-specific delivery configuration for routing to specific email/SMS provi
       #
       #   @param routing [Courier::Models::MessageRouting] Message routing configuration for multi-channel delivery strategies
-
-      class Channel < Courier::Internal::Type::BaseModel
-        # @!attribute brand_id
-        #   Brand id used for rendering.
-        #
-        #   @return [String, nil]
-        optional :brand_id, String, nil?: true
-
-        # @!attribute if_
-        #   JS conditional with access to data/profile.
-        #
-        #   @return [String, nil]
-        optional :if_, String, api_name: :if, nil?: true
-
-        # @!attribute metadata
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Channel::Metadata, nil]
-        optional :metadata, -> { Courier::TenantTemplateInput::Channel::Metadata }, nil?: true
-
-        # @!attribute override
-        #   Channel specific overrides.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute providers
-        #   Providers enabled for this channel.
-        #
-        #   @return [Array<String>, nil]
-        optional :providers, Courier::Internal::Type::ArrayOf[String], nil?: true
-
-        # @!attribute routing_method
-        #   Defaults to `single`.
-        #
-        #   @return [Symbol, Courier::Models::TenantTemplateInput::Channel::RoutingMethod, nil]
-        optional :routing_method,
-                 enum: -> {
-                   Courier::TenantTemplateInput::Channel::RoutingMethod
-                 },
-                 nil?: true
-
-        # @!attribute timeouts
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Channel::Timeouts, nil]
-        optional :timeouts, -> { Courier::TenantTemplateInput::Channel::Timeouts }, nil?: true
-
-        # @!method initialize(brand_id: nil, if_: nil, metadata: nil, override: nil, providers: nil, routing_method: nil, timeouts: nil)
-        #   @param brand_id [String, nil] Brand id used for rendering.
-        #
-        #   @param if_ [String, nil] JS conditional with access to data/profile.
-        #
-        #   @param metadata [Courier::Models::TenantTemplateInput::Channel::Metadata, nil]
-        #
-        #   @param override [Hash{Symbol=>Object}, nil] Channel specific overrides.
-        #
-        #   @param providers [Array<String>, nil] Providers enabled for this channel.
-        #
-        #   @param routing_method [Symbol, Courier::Models::TenantTemplateInput::Channel::RoutingMethod, nil] Defaults to `single`.
-        #
-        #   @param timeouts [Courier::Models::TenantTemplateInput::Channel::Timeouts, nil]
-
-        # @see Courier::Models::TenantTemplateInput::Channel#metadata
-        class Metadata < Courier::Internal::Type::BaseModel
-          # @!attribute utm
-          #
-          #   @return [Courier::Models::Utm, nil]
-          optional :utm, -> { Courier::Utm }, nil?: true
-
-          # @!method initialize(utm: nil)
-          #   @param utm [Courier::Models::Utm, nil]
-        end
-
-        # Defaults to `single`.
-        #
-        # @see Courier::Models::TenantTemplateInput::Channel#routing_method
-        module RoutingMethod
-          extend Courier::Internal::Type::Enum
-
-          ALL = :all
-          SINGLE = :single
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Courier::Models::TenantTemplateInput::Channel#timeouts
-        class Timeouts < Courier::Internal::Type::BaseModel
-          # @!attribute channel
-          #
-          #   @return [Integer, nil]
-          optional :channel, Integer, nil?: true
-
-          # @!attribute provider
-          #
-          #   @return [Integer, nil]
-          optional :provider, Integer, nil?: true
-
-          # @!method initialize(channel: nil, provider: nil)
-          #   @param channel [Integer, nil]
-          #   @param provider [Integer, nil]
-        end
-      end
-
-      class Provider < Courier::Internal::Type::BaseModel
-        # @!attribute if_
-        #   JS conditional with access to data/profile.
-        #
-        #   @return [String, nil]
-        optional :if_, String, api_name: :if, nil?: true
-
-        # @!attribute metadata
-        #
-        #   @return [Courier::Models::TenantTemplateInput::Provider::Metadata, nil]
-        optional :metadata, -> { Courier::TenantTemplateInput::Provider::Metadata }, nil?: true
-
-        # @!attribute override
-        #   Provider-specific overrides.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute timeouts
-        #
-        #   @return [Integer, nil]
-        optional :timeouts, Integer, nil?: true
-
-        # @!method initialize(if_: nil, metadata: nil, override: nil, timeouts: nil)
-        #   @param if_ [String, nil] JS conditional with access to data/profile.
-        #
-        #   @param metadata [Courier::Models::TenantTemplateInput::Provider::Metadata, nil]
-        #
-        #   @param override [Hash{Symbol=>Object}, nil] Provider-specific overrides.
-        #
-        #   @param timeouts [Integer, nil]
-
-        # @see Courier::Models::TenantTemplateInput::Provider#metadata
-        class Metadata < Courier::Internal::Type::BaseModel
-          # @!attribute utm
-          #
-          #   @return [Courier::Models::Utm, nil]
-          optional :utm, -> { Courier::Utm }, nil?: true
-
-          # @!method initialize(utm: nil)
-          #   @param utm [Courier::Models::Utm, nil]
-        end
-      end
     end
   end
 end

data/lib/courier/models/timeouts.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class Timeouts < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #
+      #   @return [Integer, nil]
+      optional :channel, Integer, nil?: true
+
+      # @!attribute provider
+      #
+      #   @return [Integer, nil]
+      optional :provider, Integer, nil?: true
+
+      # @!method initialize(channel: nil, provider: nil)
+      #   @param channel [Integer, nil]
+      #   @param provider [Integer, nil]
+    end
+  end
+end

data/lib/courier/models/version_node.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class VersionNode < Courier::Internal::Type::BaseModel
+      # @!attribute created
+      #   Epoch milliseconds when this version was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the version creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute version
+      #   Version identifier. One of "draft", "published:vNNN" (current published
+      #   version), or "vNNN" (historical version).
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!attribute has_changes
+      #   Whether the draft has unpublished changes. Only present on the draft version.
+      #
+      #   @return [Boolean, nil]
+      optional :has_changes, Courier::Internal::Type::Boolean
+
+      # @!method initialize(created:, creator:, version:, has_changes: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::VersionNode} for more details.
+      #
+      #   A version entry for a notification template.
+      #
+      #   @param created [Integer] Epoch milliseconds when this version was created.
+      #
+      #   @param creator [String] User ID of the version creator.
+      #
+      #   @param version [String] Version identifier. One of "draft", "published:vNNN" (current published version)
+      #
+      #   @param has_changes [Boolean] Whether the draft has unpublished changes. Only present on the draft version.
+    end
+  end
+end