trycourier 4.8.0 → 4.10.0

data/lib/courier/models.rb

@@ -45,6 +45,8 @@ module Courier
 
   Alignment = Courier::Models::Alignment
 
+  AssociatedNotificationListResponse = Courier::Models::AssociatedNotificationListResponse
+
   Audience = Courier::Models::Audience
 
   AudienceDeleteParams = Courier::Models::AudienceDeleteParams
@@ -121,8 +123,12 @@ module Courier
 
   BulkRunJobParams = Courier::Models::BulkRunJobParams
 
+  Channel = Courier::Models::Channel
+
   ChannelClassification = Courier::Models::ChannelClassification
 
+  ChannelMetadata = Courier::Models::ChannelMetadata
+
   ChannelPreference = Courier::Models::ChannelPreference
 
   Check = Courier::Models::Check
@@ -147,6 +153,8 @@ module Courier
 
   ElementalDividerNodeWithType = Courier::Models::ElementalDividerNodeWithType
 
+  ElementalHTMLNodeWithType = Courier::Models::ElementalHTMLNodeWithType
+
   ElementalImageNodeWithType = Courier::Models::ElementalImageNodeWithType
 
   ElementalMetaNodeWithType = Courier::Models::ElementalMetaNodeWithType
@@ -157,6 +165,8 @@ module Courier
 
   ElementalTextNodeWithType = Courier::Models::ElementalTextNodeWithType
 
+  ElementWithChecksums = Courier::Models::ElementWithChecksums
+
   EmailFooter = Courier::Models::EmailFooter
 
   EmailHead = Courier::Models::EmailHead
@@ -213,6 +223,9 @@ module Courier
 
   MessageCancelParams = Courier::Models::MessageCancelParams
 
+  # @type [Courier::Internal::Type::Converter]
+  MessageChannels = Courier::Models::MessageChannels
+
   MessageContentParams = Courier::Models::MessageContentParams
 
   MessageContext = Courier::Models::MessageContext
@@ -223,12 +236,19 @@ module Courier
 
   MessageListParams = Courier::Models::MessageListParams
 
+  # @type [Courier::Internal::Type::Converter]
+  MessageProviders = Courier::Models::MessageProviders
+
+  MessageProvidersType = Courier::Models::MessageProvidersType
+
   MessageRetrieveParams = Courier::Models::MessageRetrieveParams
 
   MessageRouting = Courier::Models::MessageRouting
 
   MessageRoutingChannel = Courier::Models::MessageRoutingChannel
 
+  Metadata = Courier::Models::Metadata
+
   MsTeams = Courier::Models::MsTeams
 
   MsTeamsBaseProperties = Courier::Models::MsTeamsBaseProperties
@@ -237,16 +257,62 @@ module Courier
 
   MultipleTokens = Courier::Models::MultipleTokens
 
+  NotificationArchiveParams = Courier::Models::NotificationArchiveParams
+
+  NotificationContentGetResponse = Courier::Models::NotificationContentGetResponse
+
+  NotificationContentMutationResponse = Courier::Models::NotificationContentMutationResponse
+
+  NotificationContentPutRequest = Courier::Models::NotificationContentPutRequest
+
+  NotificationCreateParams = Courier::Models::NotificationCreateParams
+
+  NotificationElementPutRequest = Courier::Models::NotificationElementPutRequest
+
   NotificationGetContent = Courier::Models::NotificationGetContent
 
   NotificationListParams = Courier::Models::NotificationListParams
 
+  NotificationListVersionsParams = Courier::Models::NotificationListVersionsParams
+
+  NotificationLocalePutRequest = Courier::Models::NotificationLocalePutRequest
+
   NotificationPreferenceDetails = Courier::Models::NotificationPreferenceDetails
 
+  NotificationPublishParams = Courier::Models::NotificationPublishParams
+
+  NotificationPutContentParams = Courier::Models::NotificationPutContentParams
+
+  NotificationPutElementParams = Courier::Models::NotificationPutElementParams
+
+  NotificationPutLocaleParams = Courier::Models::NotificationPutLocaleParams
+
+  NotificationReplaceParams = Courier::Models::NotificationReplaceParams
+
   NotificationRetrieveContentParams = Courier::Models::NotificationRetrieveContentParams
 
+  NotificationRetrieveParams = Courier::Models::NotificationRetrieveParams
+
   Notifications = Courier::Models::Notifications
 
+  NotificationTemplateCreateRequest = Courier::Models::NotificationTemplateCreateRequest
+
+  NotificationTemplateGetResponse = Courier::Models::NotificationTemplateGetResponse
+
+  NotificationTemplateMutationResponse = Courier::Models::NotificationTemplateMutationResponse
+
+  NotificationTemplatePayload = Courier::Models::NotificationTemplatePayload
+
+  NotificationTemplatePublishRequest = Courier::Models::NotificationTemplatePublishRequest
+
+  NotificationTemplateState = Courier::Models::NotificationTemplateState
+
+  NotificationTemplateSummary = Courier::Models::NotificationTemplateSummary
+
+  NotificationTemplateUpdateRequest = Courier::Models::NotificationTemplateUpdateRequest
+
+  NotificationTemplateVersionListResponse = Courier::Models::NotificationTemplateVersionListResponse
+
   Pagerduty = Courier::Models::Pagerduty
 
   PagerdutyRecipient = Courier::Models::PagerdutyRecipient
@@ -273,6 +339,22 @@ module Courier
 
   ProfileUpdateParams = Courier::Models::ProfileUpdateParams
 
+  Provider = Courier::Models::Provider
+
+  ProviderCreateParams = Courier::Models::ProviderCreateParams
+
+  ProviderDeleteParams = Courier::Models::ProviderDeleteParams
+
+  ProviderListParams = Courier::Models::ProviderListParams
+
+  ProviderRetrieveParams = Courier::Models::ProviderRetrieveParams
+
+  Providers = Courier::Models::Providers
+
+  ProvidersCatalogEntry = Courier::Models::ProvidersCatalogEntry
+
+  ProviderUpdateParams = Courier::Models::ProviderUpdateParams
+
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest
@@ -283,6 +365,30 @@ module Courier
 
   RequestArchiveParams = Courier::Models::RequestArchiveParams
 
+  RoutingStrategyArchiveParams = Courier::Models::RoutingStrategyArchiveParams
+
+  RoutingStrategyCreateParams = Courier::Models::RoutingStrategyCreateParams
+
+  RoutingStrategyCreateRequest = Courier::Models::RoutingStrategyCreateRequest
+
+  RoutingStrategyGetResponse = Courier::Models::RoutingStrategyGetResponse
+
+  RoutingStrategyListNotificationsParams = Courier::Models::RoutingStrategyListNotificationsParams
+
+  RoutingStrategyListParams = Courier::Models::RoutingStrategyListParams
+
+  RoutingStrategyListResponse = Courier::Models::RoutingStrategyListResponse
+
+  RoutingStrategyMutationResponse = Courier::Models::RoutingStrategyMutationResponse
+
+  RoutingStrategyReplaceParams = Courier::Models::RoutingStrategyReplaceParams
+
+  RoutingStrategyReplaceRequest = Courier::Models::RoutingStrategyReplaceRequest
+
+  RoutingStrategyRetrieveParams = Courier::Models::RoutingStrategyRetrieveParams
+
+  RoutingStrategySummary = Courier::Models::RoutingStrategySummary
+
   Rule = Courier::Models::Rule
 
   SendDirectMessage = Courier::Models::SendDirectMessage
@@ -339,6 +445,8 @@ module Courier
 
   TextStyle = Courier::Models::TextStyle
 
+  Timeouts = Courier::Models::Timeouts
+
   Token = Courier::Models::Token
 
   TranslationRetrieveParams = Courier::Models::TranslationRetrieveParams
@@ -355,6 +463,8 @@ module Courier
 
   Utm = Courier::Models::Utm
 
+  VersionNode = Courier::Models::VersionNode
+
   WebhookAuthentication = Courier::Models::WebhookAuthentication
 
   WebhookAuthMode = Courier::Models::WebhookAuthMode

data/lib/courier/resources/notifications.rb

@@ -3,17 +3,75 @@
 module Courier
   module Resources
     class Notifications
-      # @return [Courier::Resources::Notifications::Draft]
-      attr_reader :draft
-
       # @return [Courier::Resources::Notifications::Checks]
       attr_reader :checks
 
-      # @overload list(cursor: nil, notes: nil, request_options: {})
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::NotificationCreateParams} for more details.
+      #
+      # Create a notification template. Requires all fields in the notification object.
+      # Templates are created in draft state by default.
+      #
+      # @overload create(notification:, state: nil, request_options: {})
+      #
+      # @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationTemplateMutationResponse]
+      #
+      # @see Courier::Models::NotificationCreateParams
+      def create(params)
+        parsed, options = Courier::NotificationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "notifications",
+          body: parsed,
+          model: Courier::NotificationTemplateMutationResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::NotificationRetrieveParams} for more details.
+      #
+      # Retrieve a notification template by ID. Returns the published version by
+      # default. Pass version=draft to retrieve an unpublished template.
+      #
+      # @overload retrieve(id, version: nil, request_options: {})
+      #
+      # @param id [String] Template ID (nt\_ prefix).
+      #
+      # @param version [String] Version to retrieve. One of "draft", "published", or a version string like "v001
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationTemplateGetResponse]
+      #
+      # @see Courier::Models::NotificationRetrieveParams
+      def retrieve(id, params = {})
+        parsed, options = Courier::NotificationRetrieveParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["notifications/%1$s", id],
+          query: query,
+          model: Courier::NotificationTemplateGetResponse,
+          options: options
+        )
+      end
+
+      # List notification templates in your workspace.
+      #
+      # @overload list(cursor: nil, event_id: nil, notes: nil, request_options: {})
       #
-      # @param cursor [String, nil]
+      # @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
       #
-      # @param notes [Boolean, nil] Retrieve the notes from the Notification template settings.
+      # @param event_id [String] Filter to templates linked to this event map ID.
+      #
+      # @param notes [Boolean, nil] Include template notes in the response. Only applies to legacy templates.
       #
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -32,20 +90,240 @@ module Courier
         )
       end
 
-      # @overload retrieve_content(id, request_options: {})
+      # Archive a notification template.
+      #
+      # @overload archive(id, request_options: {})
+      #
+      # @param id [String] Template ID (nt\_ prefix).
       #
-      # @param id [String]
       # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Courier::Models::NotificationGetContent]
+      # @return [nil]
+      #
+      # @see Courier::Models::NotificationArchiveParams
+      def archive(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["notifications/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # List versions of a notification template.
+      #
+      # @overload list_versions(id, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param id [String] Template ID (nt\_ prefix).
+      #
+      # @param cursor [String] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      # @param limit [Integer] Maximum number of versions to return per page. Default 10, max 10.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationTemplateVersionListResponse]
+      #
+      # @see Courier::Models::NotificationListVersionsParams
+      def list_versions(id, params = {})
+        parsed, options = Courier::NotificationListVersionsParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["notifications/%1$s/versions", id],
+          query: query,
+          model: Courier::NotificationTemplateVersionListResponse,
+          options: options
+        )
+      end
+
+      # Publish a notification template. Publishes the current draft by default. Pass a
+      # version in the request body to publish a specific historical version.
+      #
+      # @overload publish(id, version: nil, request_options: {})
+      #
+      # @param id [String] Template ID (nt\_ prefix).
+      #
+      # @param version [String] Historical version to publish (e.g. "v001"). Omit to publish the current draft.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::NotificationPublishParams
+      def publish(id, params = {})
+        parsed, options = Courier::NotificationPublishParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["notifications/%1$s/publish", id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Replace the elemental content of a notification template. Overwrites all
+      # elements in the template with the provided content. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_content(id, content:, state: nil, request_options: {})
+      #
+      # @param id [String] Notification template ID (`nt_` prefix).
+      #
+      # @param content [Courier::Models::NotificationContentPutRequest::Content] Elemental content payload. The server defaults `version` when omitted.
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutContentParams
+      def put_content(id, params)
+        parsed, options = Courier::NotificationPutContentParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/content", id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Update a single element within a notification template. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_element(element_id, id:, type:, channels: nil, data: nil, if_: nil, loop_: nil, ref: nil, state: nil, request_options: {})
+      #
+      # @param element_id [String] Path param: Element ID within the template.
+      #
+      # @param id [String] Path param: Notification template ID (`nt_` prefix).
+      #
+      # @param type [String] Body param: Element type (text, meta, action, image, etc.).
+      #
+      # @param channels [Array<String>] Body param
+      #
+      # @param data [Hash{Symbol=>Object}] Body param
+      #
+      # @param if_ [String] Body param
+      #
+      # @param loop_ [String] Body param
+      #
+      # @param ref [String] Body param
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutElementParams
+      def put_element(element_id, params)
+        parsed, options = Courier::NotificationPutElementParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/elements/%2$s", id, element_id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Set locale-specific content overrides for a notification template. Each element
+      # override must reference an existing element by ID. Only supported for V2
+      # (elemental) templates.
+      #
+      # @overload put_locale(locale_id, id:, elements:, state: nil, request_options: {})
+      #
+      # @param locale_id [String] Path param: Locale code (e.g., `es`, `fr`, `pt-BR`).
+      #
+      # @param id [String] Path param: Notification template ID (`nt_` prefix).
+      #
+      # @param elements [Array<Courier::Models::NotificationLocalePutRequest::Element>] Body param: Elements with locale-specific content overrides.
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Body param: Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::NotificationPutLocaleParams
+      def put_locale(locale_id, params)
+        parsed, options = Courier::NotificationPutLocaleParams.dump_request(params)
+        id =
+          parsed.delete(:id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s/locales/%2$s", id, locale_id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::NotificationReplaceParams} for more details.
+      #
+      # Replace a notification template. All fields are required.
+      #
+      # @overload replace(id, notification:, state: nil, request_options: {})
+      #
+      # @param id [String] Template ID (nt\_ prefix).
+      #
+      # @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationTemplateMutationResponse]
+      #
+      # @see Courier::Models::NotificationReplaceParams
+      def replace(id, params)
+        parsed, options = Courier::NotificationReplaceParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["notifications/%1$s", id],
+          body: parsed,
+          model: Courier::NotificationTemplateMutationResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::NotificationRetrieveContentParams} for more details.
+      #
+      # Retrieve the content of a notification template. The response shape depends on
+      # whether the template uses V1 (blocks/channels) or V2 (elemental) content. Use
+      # the `version` query parameter to select draft, published, or a specific
+      # historical version.
+      #
+      # @overload retrieve_content(id, version: nil, request_options: {})
+      #
+      # @param id [String] Notification template ID (`nt_` prefix).
+      #
+      # @param version [String] Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to `p
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentGetResponse, Courier::Models::NotificationGetContent]
       #
       # @see Courier::Models::NotificationRetrieveContentParams
       def retrieve_content(id, params = {})
+        parsed, options = Courier::NotificationRetrieveContentParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["notifications/%1$s/content", id],
-          model: Courier::NotificationGetContent,
-          options: params[:request_options]
+          query: query,
+          model: Courier::Models::NotificationRetrieveContentResponse,
+          options: options
         )
       end
 
@@ -54,7 +332,6 @@ module Courier
       # @param client [Courier::Client]
       def initialize(client:)
         @client = client
-        @draft = Courier::Resources::Notifications::Draft.new(client: client)
         @checks = Courier::Resources::Notifications::Checks.new(client: client)
       end
     end

data/lib/courier/resources/providers/catalog.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Providers
+      class Catalog
+        # Some parameter documentations has been truncated, see
+        # {Courier::Models::Providers::CatalogListParams} for more details.
+        #
+        # Returns the catalog of available provider types with their display names,
+        # descriptions, and configuration schema fields (snake_case, with `type` and
+        # `required`). Providers with no configurable schema return only `provider`,
+        # `name`, and `description`.
+        #
+        # @overload list(channel: nil, keys: nil, name: nil, request_options: {})
+        #
+        # @param channel [String] Exact match (case-insensitive) against the provider channel taxonomy (e.g. `emai
+        #
+        # @param keys [String] Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+        #
+        # @param name [String] Case-insensitive substring match against the provider display name.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::Providers::CatalogListResponse]
+        #
+        # @see Courier::Models::Providers::CatalogListParams
+        def list(params = {})
+          parsed, options = Courier::Providers::CatalogListParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "providers/catalog",
+            query: query,
+            model: Courier::Models::Providers::CatalogListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Courier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end