trycourier 4.8.0 → 4.9.0

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.8.0"
+  VERSION = "4.9.0"
 end

data/lib/courier.rb

@@ -60,6 +60,12 @@ require_relative "courier/models/subscription_topic_new"
 require_relative "courier/models/elemental_channel_node"
 require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/message_details"
+require_relative "courier/models/notification_template_create_request"
+require_relative "courier/models/notification_template_publish_request"
+require_relative "courier/models/notification_template_update_request"
+require_relative "courier/models/notification_template_payload"
+require_relative "courier/models/routing_strategy_create_request"
+require_relative "courier/models/routing_strategy_replace_request"
 require_relative "courier/models/base_template_tenant_association"
 require_relative "courier/models/post_tenant_template_publish_request"
 require_relative "courier/models/put_tenant_template_request"
@@ -112,7 +118,9 @@ require_relative "courier/models/bulk_list_users_response"
 require_relative "courier/models/bulk_retrieve_job_params"
 require_relative "courier/models/bulk_retrieve_job_response"
 require_relative "courier/models/bulk_run_job_params"
+require_relative "courier/models/channel"
 require_relative "courier/models/channel_classification"
+require_relative "courier/models/channel_metadata"
 require_relative "courier/models/channel_preference"
 require_relative "courier/models/check"
 require_relative "courier/models/default_preferences"
@@ -123,6 +131,7 @@ require_relative "courier/models/elemental_channel_node_with_type"
 require_relative "courier/models/elemental_content"
 require_relative "courier/models/elemental_content_sugar"
 require_relative "courier/models/elemental_divider_node_with_type"
+require_relative "courier/models/elemental_html_node_with_type"
 require_relative "courier/models/elemental_image_node_with_type"
 require_relative "courier/models/elemental_meta_node_with_type"
 require_relative "courier/models/elemental_node"
@@ -161,6 +170,7 @@ require_relative "courier/models/lists/subscription_unsubscribe_user_params"
 require_relative "courier/models/list_update_params"
 require_relative "courier/models/logo"
 require_relative "courier/models/message_cancel_params"
+require_relative "courier/models/message_channels"
 require_relative "courier/models/message_content_params"
 require_relative "courier/models/message_content_response"
 require_relative "courier/models/message_context"
@@ -168,25 +178,38 @@ require_relative "courier/models/message_history_params"
 require_relative "courier/models/message_history_response"
 require_relative "courier/models/message_list_params"
 require_relative "courier/models/message_list_response"
+require_relative "courier/models/message_providers"
+require_relative "courier/models/message_providers_type"
 require_relative "courier/models/message_retrieve_params"
 require_relative "courier/models/message_retrieve_response"
 require_relative "courier/models/message_routing"
 require_relative "courier/models/message_routing_channel"
+require_relative "courier/models/metadata"
 require_relative "courier/models/ms_teams"
 require_relative "courier/models/ms_teams_base_properties"
 require_relative "courier/models/ms_teams_recipient"
 require_relative "courier/models/multiple_tokens"
+require_relative "courier/models/notification_archive_params"
+require_relative "courier/models/notification_create_params"
 require_relative "courier/models/notification_get_content"
 require_relative "courier/models/notification_list_params"
 require_relative "courier/models/notification_list_response"
+require_relative "courier/models/notification_list_versions_params"
 require_relative "courier/models/notification_preference_details"
+require_relative "courier/models/notification_publish_params"
+require_relative "courier/models/notification_replace_params"
 require_relative "courier/models/notification_retrieve_content_params"
+require_relative "courier/models/notification_retrieve_params"
 require_relative "courier/models/notifications/check_delete_params"
 require_relative "courier/models/notifications/check_list_params"
 require_relative "courier/models/notifications/check_list_response"
 require_relative "courier/models/notifications/check_update_params"
 require_relative "courier/models/notifications/check_update_response"
 require_relative "courier/models/notifications/draft_retrieve_content_params"
+require_relative "courier/models/notification_template_get_response"
+require_relative "courier/models/notification_template_mutation_response"
+require_relative "courier/models/notification_template_summary"
+require_relative "courier/models/notification_template_version_list_response"
 require_relative "courier/models/pagerduty"
 require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
@@ -207,10 +230,29 @@ require_relative "courier/models/profiles/list_retrieve_response"
 require_relative "courier/models/profiles/list_subscribe_params"
 require_relative "courier/models/profiles/list_subscribe_response"
 require_relative "courier/models/profile_update_params"
+require_relative "courier/models/provider"
+require_relative "courier/models/provider_create_params"
+require_relative "courier/models/provider_delete_params"
+require_relative "courier/models/provider_list_params"
+require_relative "courier/models/provider_list_response"
+require_relative "courier/models/provider_retrieve_params"
+require_relative "courier/models/providers/catalog_list_params"
+require_relative "courier/models/providers/catalog_list_response"
+require_relative "courier/models/providers_catalog_entry"
+require_relative "courier/models/provider_update_params"
 require_relative "courier/models/put_subscriptions_recipient"
 require_relative "courier/models/put_tenant_template_response"
 require_relative "courier/models/recipient_preferences"
 require_relative "courier/models/request_archive_params"
+require_relative "courier/models/routing_strategy_archive_params"
+require_relative "courier/models/routing_strategy_create_params"
+require_relative "courier/models/routing_strategy_get_response"
+require_relative "courier/models/routing_strategy_list_params"
+require_relative "courier/models/routing_strategy_list_response"
+require_relative "courier/models/routing_strategy_mutation_response"
+require_relative "courier/models/routing_strategy_replace_params"
+require_relative "courier/models/routing_strategy_retrieve_params"
+require_relative "courier/models/routing_strategy_summary"
 require_relative "courier/models/rule"
 require_relative "courier/models/send_direct_message"
 require_relative "courier/models/send_message_params"
@@ -248,6 +290,7 @@ require_relative "courier/models/tenants/templates/version_retrieve_params"
 require_relative "courier/models/tenant_template_input"
 require_relative "courier/models/tenant_update_params"
 require_relative "courier/models/text_style"
+require_relative "courier/models/timeouts"
 require_relative "courier/models/token"
 require_relative "courier/models/translation_retrieve_params"
 require_relative "courier/models/translation_retrieve_response"
@@ -277,6 +320,7 @@ require_relative "courier/models/users/token_retrieve_response"
 require_relative "courier/models/users/token_update_params"
 require_relative "courier/models/users/topic_preference"
 require_relative "courier/models/utm"
+require_relative "courier/models/version_node"
 require_relative "courier/models/webhook_authentication"
 require_relative "courier/models/webhook_auth_mode"
 require_relative "courier/models/webhook_method"
@@ -302,7 +346,10 @@ require_relative "courier/resources/notifications/checks"
 require_relative "courier/resources/notifications/draft"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
+require_relative "courier/resources/providers"
+require_relative "courier/resources/providers/catalog"
 require_relative "courier/resources/requests"
+require_relative "courier/resources/routing_strategies"
 require_relative "courier/resources/send"
 require_relative "courier/resources/tenants"
 require_relative "courier/resources/tenants/preferences"

data/rbi/courier/client.rbi

@@ -19,6 +19,9 @@ module Courier
     sig { returns(Courier::Resources::Audiences) }
     attr_reader :audiences
 
+    sig { returns(Courier::Resources::Providers) }
+    attr_reader :providers
+
     sig { returns(Courier::Resources::AuditEvents) }
     attr_reader :audit_events
 
@@ -52,6 +55,9 @@ module Courier
     sig { returns(Courier::Resources::Notifications) }
     attr_reader :notifications
 
+    sig { returns(Courier::Resources::RoutingStrategies) }
+    attr_reader :routing_strategies
+
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 

data/rbi/courier/internal/util.rbi

@@ -148,12 +148,20 @@ module Courier
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)

data/rbi/courier/models/channel.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Channel < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Channel, Courier::Internal::AnyHash) }
+
+      # Brand id used for rendering.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::ChannelMetadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::ChannelMetadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Channel specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      # Providers enabled for this channel.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :providers
+
+      # Defaults to `single`.
+      sig { returns(T.nilable(Courier::Channel::RoutingMethod::OrSymbol)) }
+      attr_accessor :routing_method
+
+      sig { returns(T.nilable(Courier::Timeouts)) }
+      attr_reader :timeouts
+
+      sig { params(timeouts: T.nilable(Courier::Timeouts::OrHash)).void }
+      attr_writer :timeouts
+
+      sig do
+        params(
+          brand_id: T.nilable(String),
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::ChannelMetadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          providers: T.nilable(T::Array[String]),
+          routing_method: T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+          timeouts: T.nilable(Courier::Timeouts::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Brand id used for rendering.
+        brand_id: nil,
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Channel specific overrides.
+        override: nil,
+        # Providers enabled for this channel.
+        providers: nil,
+        # Defaults to `single`.
+        routing_method: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            brand_id: T.nilable(String),
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::ChannelMetadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            providers: T.nilable(T::Array[String]),
+            routing_method:
+              T.nilable(Courier::Channel::RoutingMethod::OrSymbol),
+            timeouts: T.nilable(Courier::Timeouts)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Defaults to `single`.
+      module RoutingMethod
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Channel::RoutingMethod) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALL = T.let(:all, Courier::Channel::RoutingMethod::TaggedSymbol)
+        SINGLE = T.let(:single, Courier::Channel::RoutingMethod::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::Channel::RoutingMethod::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/channel_metadata.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ChannelMetadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ChannelMetadata, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_content.rbi

@@ -18,7 +18,8 @@ module Courier
               Courier::ElementalImageNodeWithType,
               Courier::ElementalActionNodeWithType,
               Courier::ElementalDividerNodeWithType,
-              Courier::ElementalQuoteNodeWithType
+              Courier::ElementalQuoteNodeWithType,
+              Courier::ElementalHTMLNodeWithType
             )
           ]
         )
@@ -40,7 +41,8 @@ module Courier
                 Courier::ElementalImageNodeWithType::OrHash,
                 Courier::ElementalActionNodeWithType::OrHash,
                 Courier::ElementalDividerNodeWithType::OrHash,
-                Courier::ElementalQuoteNodeWithType::OrHash
+                Courier::ElementalQuoteNodeWithType::OrHash,
+                Courier::ElementalHTMLNodeWithType::OrHash
               )
             ],
           version: String
@@ -65,7 +67,8 @@ module Courier
                   Courier::ElementalImageNodeWithType,
                   Courier::ElementalActionNodeWithType,
                   Courier::ElementalDividerNodeWithType,
-                  Courier::ElementalQuoteNodeWithType
+                  Courier::ElementalQuoteNodeWithType,
+                  Courier::ElementalHTMLNodeWithType
                 )
               ],
             version: String

data/rbi/courier/models/elemental_html_node_with_type.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ElementalHTMLNodeWithType < Courier::Models::ElementalBaseNode
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ElementalHTMLNodeWithType, Courier::Internal::AnyHash)
+        end
+
+      sig do
+        returns(T.nilable(Courier::ElementalHTMLNodeWithType::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(type: nil)
+      end
+
+      sig do
+        override.returns(
+          { type: Courier::ElementalHTMLNodeWithType::Type::OrSymbol }
+        )
+      end
+      def to_hash
+      end
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::ElementalHTMLNodeWithType::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HTML =
+          T.let(:html, Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Courier::ElementalHTMLNodeWithType::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/elemental_node.rbi

@@ -24,7 +24,8 @@ module Courier
             Courier::ElementalImageNodeWithType,
             Courier::ElementalActionNodeWithType,
             Courier::ElementalDividerNodeWithType,
-            Courier::ElementalQuoteNodeWithType
+            Courier::ElementalQuoteNodeWithType,
+            Courier::ElementalHTMLNodeWithType
           )
         end
 

data/rbi/courier/models/message_channels.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageChannels =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::Channel],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_providers.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Courier
+  module Models
+    MessageProviders =
+      T.let(
+        Courier::Internal::Type::HashOf[Courier::MessageProvidersType],
+        Courier::Internal::Type::Converter
+      )
+  end
+end

data/rbi/courier/models/message_providers_type.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Courier
+  module Models
+    class MessageProvidersType < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::MessageProvidersType, Courier::Internal::AnyHash)
+        end
+
+      # JS conditional with access to data/profile.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :if_
+
+      sig { returns(T.nilable(Courier::Metadata)) }
+      attr_reader :metadata
+
+      sig { params(metadata: T.nilable(Courier::Metadata::OrHash)).void }
+      attr_writer :metadata
+
+      # Provider-specific overrides.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :timeouts
+
+      sig do
+        params(
+          if_: T.nilable(String),
+          metadata: T.nilable(Courier::Metadata::OrHash),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          timeouts: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # JS conditional with access to data/profile.
+        if_: nil,
+        metadata: nil,
+        # Provider-specific overrides.
+        override: nil,
+        timeouts: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            if_: T.nilable(String),
+            metadata: T.nilable(Courier::Metadata),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            timeouts: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/metadata.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Metadata < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Metadata, Courier::Internal::AnyHash) }
+
+      sig { returns(T.nilable(Courier::Utm)) }
+      attr_reader :utm
+
+      sig { params(utm: T.nilable(Courier::Utm::OrHash)).void }
+      attr_writer :utm
+
+      sig do
+        params(utm: T.nilable(Courier::Utm::OrHash)).returns(T.attached_class)
+      end
+      def self.new(utm: nil)
+      end
+
+      sig { override.returns({ utm: T.nilable(Courier::Utm) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_archive_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::NotificationArchiveParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: Courier::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_create_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationCreateParams < Courier::Models::NotificationTemplateCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::NotificationCreateParams, Courier::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Courier::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_list_params.rbi

@@ -11,23 +11,35 @@ module Courier
           T.any(Courier::NotificationListParams, Courier::Internal::AnyHash)
         end
 
+      # Opaque pagination cursor from a previous response. Omit for the first page.
       sig { returns(T.nilable(String)) }
       attr_accessor :cursor
 
-      # Retrieve the notes from the Notification template settings.
+      # Filter to templates linked to this event map ID.
+      sig { returns(T.nilable(String)) }
+      attr_reader :event_id
+
+      sig { params(event_id: String).void }
+      attr_writer :event_id
+
+      # Include template notes in the response. Only applies to legacy templates.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :notes
 
       sig do
         params(
           cursor: T.nilable(String),
+          event_id: String,
           notes: T.nilable(T::Boolean),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        # Opaque pagination cursor from a previous response. Omit for the first page.
         cursor: nil,
-        # Retrieve the notes from the Notification template settings.
+        # Filter to templates linked to this event map ID.
+        event_id: nil,
+        # Include template notes in the response. Only applies to legacy templates.
         notes: nil,
         request_options: {}
       )
@@ -37,6 +49,7 @@ module Courier
         override.returns(
           {
             cursor: T.nilable(String),
+            event_id: String,
             notes: T.nilable(T::Boolean),
             request_options: Courier::RequestOptions
           }