trycourier 4.8.0 → 4.10.0

data/lib/courier/resources/providers.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Providers
+      # @return [Courier::Resources::Providers::Catalog]
+      attr_reader :catalog
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProviderCreateParams} for more details.
+      #
+      # Create a new provider configuration. The `provider` field must be a known
+      # Courier provider key (see catalog).
+      #
+      # @overload create(provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      #
+      # @param provider [String] The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a kno
+      #
+      # @param alias_ [String] Optional alias for this configuration.
+      #
+      # @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys). Defaults to an empty object when o
+      #
+      # @param title [String] Optional display title. Omit to use "Default Configuration".
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Provider]
+      #
+      # @see Courier::Models::ProviderCreateParams
+      def create(params)
+        parsed, options = Courier::ProviderCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "providers",
+          body: parsed,
+          model: Courier::Provider,
+          options: options
+        )
+      end
+
+      # Fetch a single provider configuration by ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] A unique identifier of the provider configuration.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Provider]
+      #
+      # @see Courier::Models::ProviderRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["providers/%1$s", id],
+          model: Courier::Provider,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProviderUpdateParams} for more details.
+      #
+      # Update an existing provider configuration. The `provider` key is required. All
+      # other fields are optional — omitted fields are cleared from the stored
+      # configuration (this is a full replacement, not a partial merge).
+      #
+      # @overload update(id, provider:, alias_: nil, settings: nil, title: nil, request_options: {})
+      #
+      # @param id [String] A unique identifier of the provider configuration to update.
+      #
+      # @param provider [String] The provider key identifying the type.
+      #
+      # @param alias_ [String] Updated alias. Omit to clear.
+      #
+      # @param settings [Hash{Symbol=>Object}] Provider-specific settings (snake_case keys). Replaces the full settings object
+      #
+      # @param title [String] Updated display title.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Provider]
+      #
+      # @see Courier::Models::ProviderUpdateParams
+      def update(id, params)
+        parsed, options = Courier::ProviderUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["providers/%1$s", id],
+          body: parsed,
+          model: Courier::Provider,
+          options: options
+        )
+      end
+
+      # List configured provider integrations for the current workspace. Supports
+      # cursor-based pagination.
+      #
+      # @overload list(cursor: nil, request_options: {})
+      #
+      # @param cursor [String] Opaque cursor for fetching the next page.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::ProviderListResponse]
+      #
+      # @see Courier::Models::ProviderListParams
+      def list(params = {})
+        parsed, options = Courier::ProviderListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "providers",
+          query: query,
+          model: Courier::Models::ProviderListResponse,
+          options: options
+        )
+      end
+
+      # Delete a provider configuration. Returns 409 if the provider is still referenced
+      # by routing or notifications.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] A unique identifier of the provider configuration to delete.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::ProviderDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["providers/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+        @catalog = Courier::Resources::Providers::Catalog.new(client: client)
+      end
+    end
+  end
+end

data/lib/courier/resources/routing_strategies.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class RoutingStrategies
+      # Create a routing strategy. Requires a name and routing configuration at minimum.
+      # Channels and providers default to empty if omitted.
+      #
+      # @overload create(name:, routing:, channels: nil, description: nil, providers: nil, tags: nil, request_options: {})
+      #
+      # @param name [String] Human-readable name for the routing strategy.
+      #
+      # @param routing [Courier::Models::MessageRouting] Routing tree defining channel selection method and order.
+      #
+      # @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Per-channel delivery configuration. Defaults to empty if omitted.
+      #
+      # @param description [String, nil] Optional description of the routing strategy.
+      #
+      # @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil] Per-provider delivery configuration. Defaults to empty if omitted.
+      #
+      # @param tags [Array<String>, nil] Optional tags for categorization.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::RoutingStrategyMutationResponse]
+      #
+      # @see Courier::Models::RoutingStrategyCreateParams
+      def create(params)
+        parsed, options = Courier::RoutingStrategyCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "routing-strategies",
+          body: parsed,
+          model: Courier::RoutingStrategyMutationResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a routing strategy by ID. Returns the full entity including routing
+      # content and metadata.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Routing strategy ID (rs\_ prefix).
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::RoutingStrategyGetResponse]
+      #
+      # @see Courier::Models::RoutingStrategyRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["routing-strategies/%1$s", id],
+          model: Courier::RoutingStrategyGetResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # List routing strategies in your workspace. Returns metadata only (no
+      # routing/channels/providers content). Use GET /routing-strategies/{id} for full
+      # details.
+      #
+      # @overload list(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      # @param limit [Integer] Maximum number of results per page. Default 20, max 100.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::RoutingStrategyListResponse]
+      #
+      # @see Courier::Models::RoutingStrategyListParams
+      def list(params = {})
+        parsed, options = Courier::RoutingStrategyListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "routing-strategies",
+          query: query,
+          model: Courier::RoutingStrategyListResponse,
+          options: options
+        )
+      end
+
+      # Archive a routing strategy. The strategy must not have associated notification
+      # templates. Unlink all templates before archiving.
+      #
+      # @overload archive(id, request_options: {})
+      #
+      # @param id [String] Routing strategy ID (rs\_ prefix).
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::RoutingStrategyArchiveParams
+      def archive(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["routing-strategies/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # List notification templates associated with a routing strategy. Includes
+      # template metadata only, not full content.
+      #
+      # @overload list_notifications(id, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param id [String] Routing strategy ID (`rs_` prefix).
+      #
+      # @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      # @param limit [Integer] Maximum number of results per page. Default 20, max 100.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::AssociatedNotificationListResponse]
+      #
+      # @see Courier::Models::RoutingStrategyListNotificationsParams
+      def list_notifications(id, params = {})
+        parsed, options = Courier::RoutingStrategyListNotificationsParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["routing-strategies/%1$s/notifications", id],
+          query: query,
+          model: Courier::AssociatedNotificationListResponse,
+          options: options
+        )
+      end
+
+      # Replace a routing strategy. Full document replacement; the caller must send the
+      # complete desired state. Missing optional fields are cleared.
+      #
+      # @overload replace(id, name:, routing:, channels: nil, description: nil, providers: nil, tags: nil, request_options: {})
+      #
+      # @param id [String] Routing strategy ID (rs\_ prefix).
+      #
+      # @param name [String] Human-readable name for the routing strategy.
+      #
+      # @param routing [Courier::Models::MessageRouting] Routing tree defining channel selection method and order.
+      #
+      # @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Per-channel delivery configuration. Omit to clear.
+      #
+      # @param description [String, nil] Optional description. Omit or null to clear.
+      #
+      # @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil] Per-provider delivery configuration. Omit to clear.
+      #
+      # @param tags [Array<String>, nil] Optional tags. Omit or null to clear.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::RoutingStrategyMutationResponse]
+      #
+      # @see Courier::Models::RoutingStrategyReplaceParams
+      def replace(id, params)
+        parsed, options = Courier::RoutingStrategyReplaceParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["routing-strategies/%1$s", id],
+          body: parsed,
+          model: Courier::RoutingStrategyMutationResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -60,6 +60,15 @@ 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_content_put_request"
+require_relative "courier/models/notification_element_put_request"
+require_relative "courier/models/notification_locale_put_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"
@@ -67,6 +76,7 @@ require_relative "courier/models/users/user_token"
 require_relative "courier/models/airship_profile"
 require_relative "courier/models/airship_profile_audience"
 require_relative "courier/models/alignment"
+require_relative "courier/models/associated_notification_list_response"
 require_relative "courier/models/audience"
 require_relative "courier/models/audience_delete_params"
 require_relative "courier/models/audience_filter"
@@ -112,7 +122,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,11 +135,13 @@ 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"
 require_relative "courier/models/elemental_quote_node_with_type"
 require_relative "courier/models/elemental_text_node_with_type"
+require_relative "courier/models/element_with_checksums"
 require_relative "courier/models/email_footer"
 require_relative "courier/models/email_head"
 require_relative "courier/models/email_header"
@@ -161,6 +175,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 +183,44 @@ 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_content_get_response"
+require_relative "courier/models/notification_content_mutation_response"
+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_put_content_params"
+require_relative "courier/models/notification_put_element_params"
+require_relative "courier/models/notification_put_locale_params"
+require_relative "courier/models/notification_replace_params"
 require_relative "courier/models/notification_retrieve_content_params"
+require_relative "courier/models/notification_retrieve_content_response"
+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_state"
+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 +241,30 @@ 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_notifications_params"
+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 +302,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 +332,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"
@@ -299,10 +355,12 @@ require_relative "courier/resources/lists/subscriptions"
 require_relative "courier/resources/messages"
 require_relative "courier/resources/notifications"
 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/associated_notification_list_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class AssociatedNotificationListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::AssociatedNotificationListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::NotificationTemplateSummary]) }
+      attr_accessor :results
+
+      # Paginated list of notification templates associated with a routing strategy.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::NotificationTemplateSummary::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          {
+            paging: Courier::Paging,
+            results: T::Array[Courier::NotificationTemplateSummary]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end