trycourier 4.6.3 → 4.7.0

data/lib/courier/resources/tenants/templates.rb

@@ -4,6 +4,9 @@ module Courier
   module Resources
     class Tenants
       class Templates
+        # @return [Courier::Resources::Tenants::Templates::Versions]
+        attr_reader :versions
+
         # Get a Template in Tenant
         #
         # @overload retrieve(template_id, tenant_id:, request_options: {})
@@ -57,11 +60,89 @@ module Courier
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Tenants::TemplatePublishParams} for more details.
+        #
+        # Publishes a specific version of a notification template for a tenant.
+        #
+        # The template must already exist in the tenant's notification map. If no version
+        # is specified, defaults to publishing the "latest" version.
+        #
+        # @overload publish(template_id, tenant_id:, version: nil, request_options: {})
+        #
+        # @param template_id [String] Path param: Id of the template to be published.
+        #
+        # @param tenant_id [String] Path param: Id of the tenant that owns the template.
+        #
+        # @param version [String] Body param: The version of the template to publish (e.g., "v1", "v2", "latest").
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PostTenantTemplatePublishResponse]
+        #
+        # @see Courier::Models::Tenants::TemplatePublishParams
+        def publish(template_id, params)
+          parsed, options = Courier::Tenants::TemplatePublishParams.dump_request(params)
+          tenant_id =
+            parsed.delete(:tenant_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["tenants/%1$s/templates/%2$s/publish", tenant_id, template_id],
+            body: parsed,
+            model: Courier::PostTenantTemplatePublishResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Tenants::TemplateReplaceParams} for more details.
+        #
+        # Creates or updates a notification template for a tenant.
+        #
+        # If the template already exists for the tenant, it will be updated (200).
+        # Otherwise, a new template is created (201).
+        #
+        # Optionally publishes the template immediately if the `published` flag is set to
+        # true.
+        #
+        # @overload replace(template_id, tenant_id:, template:, published: nil, request_options: {})
+        #
+        # @param template_id [String] Path param: Id of the template to be created or updated.
+        #
+        # @param tenant_id [String] Path param: Id of the tenant for which to create or update the template.
+        #
+        # @param template [Courier::Models::TenantTemplateInput] Body param: Template configuration for creating or updating a tenant notificatio
+        #
+        # @param published [Boolean] Body param: Whether to publish the template immediately after saving. When true,
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::PutTenantTemplateResponse]
+        #
+        # @see Courier::Models::Tenants::TemplateReplaceParams
+        def replace(template_id, params)
+          parsed, options = Courier::Tenants::TemplateReplaceParams.dump_request(params)
+          tenant_id =
+            parsed.delete(:tenant_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["tenants/%1$s/templates/%2$s", tenant_id, template_id],
+            body: parsed,
+            model: Courier::PutTenantTemplateResponse,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Courier::Client]
         def initialize(client:)
           @client = client
+          @versions = Courier::Resources::Tenants::Templates::Versions.new(client: client)
         end
       end
     end

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -60,6 +60,8 @@ require_relative "courier/models/subscription_topic_new"
 require_relative "courier/models/elemental_channel_node"
 require_relative "courier/models/message_details"
 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"
 require_relative "courier/models/users/user_token"
 require_relative "courier/models/airship_profile"
 require_relative "courier/models/airship_profile_audience"
@@ -182,6 +184,7 @@ require_relative "courier/models/notifications/draft_retrieve_content_params"
 require_relative "courier/models/pagerduty"
 require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
+require_relative "courier/models/post_tenant_template_publish_response"
 require_relative "courier/models/preference"
 require_relative "courier/models/preference_status"
 require_relative "courier/models/profile_create_params"
@@ -199,6 +202,7 @@ 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/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/rule"
@@ -231,7 +235,11 @@ require_relative "courier/models/tenants/preferences/item_delete_params"
 require_relative "courier/models/tenants/preferences/item_update_params"
 require_relative "courier/models/tenants/template_list_params"
 require_relative "courier/models/tenants/template_list_response"
+require_relative "courier/models/tenants/template_publish_params"
+require_relative "courier/models/tenants/template_replace_params"
 require_relative "courier/models/tenants/template_retrieve_params"
+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/token"
@@ -293,6 +301,7 @@ require_relative "courier/resources/tenants"
 require_relative "courier/resources/tenants/preferences"
 require_relative "courier/resources/tenants/preferences/items"
 require_relative "courier/resources/tenants/templates"
+require_relative "courier/resources/tenants/templates/versions"
 require_relative "courier/resources/translations"
 require_relative "courier/resources/users"
 require_relative "courier/resources/users/preferences"

data/rbi/courier/models/post_tenant_template_publish_request.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PostTenantTemplatePublishRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PostTenantTemplatePublishRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The version of the template to publish (e.g., "v1", "v2", "latest"). If not
+      # provided, defaults to "latest".
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      # Request body for publishing a tenant template version
+      sig { params(version: String).returns(T.attached_class) }
+      def self.new(
+        # The version of the template to publish (e.g., "v1", "v2", "latest"). If not
+        # provided, defaults to "latest".
+        version: nil
+      )
+      end
+
+      sig { override.returns({ version: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/post_tenant_template_publish_response.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PostTenantTemplatePublishResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PostTenantTemplatePublishResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The template ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The timestamp when the template was published
+      sig { returns(String) }
+      attr_accessor :published_at
+
+      # The published version of the template
+      sig { returns(String) }
+      attr_accessor :version
+
+      # Response from publishing a tenant template
+      sig do
+        params(id: String, published_at: String, version: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # The template ID
+        id:,
+        # The timestamp when the template was published
+        published_at:,
+        # The published version of the template
+        version:
+      )
+      end
+
+      sig do
+        override.returns({ id: String, published_at: String, version: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/put_tenant_template_request.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PutTenantTemplateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PutTenantTemplateRequest, Courier::Internal::AnyHash)
+        end
+
+      # Template configuration for creating or updating a tenant notification template
+      sig { returns(Courier::TenantTemplateInput) }
+      attr_reader :template
+
+      sig { params(template: Courier::TenantTemplateInput::OrHash).void }
+      attr_writer :template
+
+      # Whether to publish the template immediately after saving. When true, the
+      # template becomes the active/published version. When false (default), the
+      # template is saved as a draft.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :published
+
+      sig { params(published: T::Boolean).void }
+      attr_writer :published
+
+      # Request body for creating or updating a tenant notification template
+      sig do
+        params(
+          template: Courier::TenantTemplateInput::OrHash,
+          published: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template configuration for creating or updating a tenant notification template
+        template:,
+        # Whether to publish the template immediately after saving. When true, the
+        # template becomes the active/published version. When false (default), the
+        # template is saved as a draft.
+        published: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { template: Courier::TenantTemplateInput, published: T::Boolean }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/put_tenant_template_response.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PutTenantTemplateResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PutTenantTemplateResponse, Courier::Internal::AnyHash)
+        end
+
+      # The template ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The version of the saved template
+      sig { returns(String) }
+      attr_accessor :version
+
+      # The timestamp when the template was published. Only present if the template was
+      # published as part of this request.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :published_at
+
+      # Response from creating or updating a tenant notification template
+      sig do
+        params(
+          id: String,
+          version: String,
+          published_at: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The template ID
+        id:,
+        # The version of the saved template
+        version:,
+        # The timestamp when the template was published. Only present if the template was
+        # published as part of this request.
+        published_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, version: String, published_at: T.nilable(String) }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/send_message_params.rbi

@@ -194,7 +194,19 @@ module Courier
                 Courier::SlackRecipient,
                 Courier::MsTeamsRecipient,
                 Courier::PagerdutyRecipient,
-                Courier::WebhookRecipient
+                Courier::WebhookRecipient,
+                T::Array[
+                  T.any(
+                    Courier::UserRecipient,
+                    Courier::AudienceRecipient,
+                    Courier::ListRecipient,
+                    Courier::ListPatternRecipient,
+                    Courier::SlackRecipient,
+                    Courier::MsTeamsRecipient,
+                    Courier::PagerdutyRecipient,
+                    Courier::WebhookRecipient
+                  )
+                ]
               )
             )
           )
@@ -252,7 +264,19 @@ module Courier
                   Courier::SlackRecipient::OrHash,
                   Courier::MsTeamsRecipient::OrHash,
                   Courier::PagerdutyRecipient::OrHash,
-                  Courier::WebhookRecipient::OrHash
+                  Courier::WebhookRecipient::OrHash,
+                  T::Array[
+                    T.any(
+                      Courier::UserRecipient::OrHash,
+                      Courier::AudienceRecipient::OrHash,
+                      Courier::ListRecipient::OrHash,
+                      Courier::ListPatternRecipient::OrHash,
+                      Courier::SlackRecipient::OrHash,
+                      Courier::MsTeamsRecipient::OrHash,
+                      Courier::PagerdutyRecipient::OrHash,
+                      Courier::WebhookRecipient::OrHash
+                    )
+                  ]
                 )
               )
           ).returns(T.attached_class)
@@ -319,7 +343,19 @@ module Courier
                     Courier::SlackRecipient,
                     Courier::MsTeamsRecipient,
                     Courier::PagerdutyRecipient,
-                    Courier::WebhookRecipient
+                    Courier::WebhookRecipient,
+                    T::Array[
+                      T.any(
+                        Courier::UserRecipient,
+                        Courier::AudienceRecipient,
+                        Courier::ListRecipient,
+                        Courier::ListPatternRecipient,
+                        Courier::SlackRecipient,
+                        Courier::MsTeamsRecipient,
+                        Courier::PagerdutyRecipient,
+                        Courier::WebhookRecipient
+                      )
+                    ]
                   )
                 )
             }
@@ -1083,9 +1119,47 @@ module Courier
                 Courier::SlackRecipient,
                 Courier::MsTeamsRecipient,
                 Courier::PagerdutyRecipient,
-                Courier::WebhookRecipient
+                Courier::WebhookRecipient,
+                T::Array[
+                  Courier::SendMessageParams::Message::To::UnionMember8::Variants
+                ]
+              )
+            end
+
+          # A single recipient of the message. Choose one of the following types based on
+          # how you want to identify the recipient: - **User**: Send to a specific user by
+          # user_id, email, or phone number - **Audience**: Send to all users in an
+          # audience - **List**: Send to all users in a list - **List Pattern**: Send to
+          # users in lists matching a pattern - **Slack**: Send via Slack (channel, email,
+          # or user_id) - **MS Teams**: Send via Microsoft Teams - **PagerDuty**: Send via
+          # PagerDuty - **Webhook**: Send via webhook
+          module UnionMember8
+            extend Courier::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  Courier::UserRecipient,
+                  Courier::AudienceRecipient,
+                  Courier::ListRecipient,
+                  Courier::ListPatternRecipient,
+                  Courier::SlackRecipient,
+                  Courier::MsTeamsRecipient,
+                  Courier::PagerdutyRecipient,
+                  Courier::WebhookRecipient
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Courier::SendMessageParams::Message::To::UnionMember8::Variants
+                ]
               )
             end
+            def self.variants
+            end
+          end
 
           sig do
             override.returns(
@@ -1094,6 +1168,14 @@ module Courier
           end
           def self.variants
           end
+
+          UnionMember8Array =
+            T.let(
+              Courier::Internal::Type::ArrayOf[
+                union: Courier::SendMessageParams::Message::To::UnionMember8
+              ],
+              Courier::Internal::Type::Converter
+            )
         end
       end
     end