trycourier 4.8.0 → 4.10.0

data/lib/courier/models/notification_element_put_request.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationElementPutRequest < Courier::Internal::Type::BaseModel
+      # @!attribute type
+      #   Element type (text, meta, action, image, etc.).
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute channels
+      #
+      #   @return [Array<String>, nil]
+      optional :channels, Courier::Internal::Type::ArrayOf[String]
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
+
+      # @!attribute if_
+      #
+      #   @return [String, nil]
+      optional :if_, String, api_name: :if
+
+      # @!attribute loop_
+      #
+      #   @return [String, nil]
+      optional :loop_, String, api_name: :loop
+
+      # @!attribute ref
+      #
+      #   @return [String, nil]
+      optional :ref, String
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!method initialize(type:, channels: nil, data: nil, if_: nil, loop_: nil, ref: nil, state: nil)
+      #   Request body for updating a single element. Additional type-specific fields are
+      #   allowed.
+      #
+      #   @param type [String] Element type (text, meta, action, image, etc.).
+      #
+      #   @param channels [Array<String>]
+      #
+      #   @param data [Hash{Symbol=>Object}]
+      #
+      #   @param if_ [String]
+      #
+      #   @param loop_ [String]
+      #
+      #   @param ref [String]
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+    end
+  end
+end

data/lib/courier/models/notification_get_content.rb

@@ -2,7 +2,6 @@
 
 module Courier
   module Models
-    # @see Courier::Resources::Notifications#retrieve_content
     class NotificationGetContent < Courier::Internal::Type::BaseModel
       # @!attribute blocks
       #

data/lib/courier/models/notification_list_params.rb

@@ -8,20 +8,29 @@ module Courier
       include Courier::Internal::Type::RequestParameters
 
       # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
       #
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
+      # @!attribute event_id
+      #   Filter to templates linked to this event map ID.
+      #
+      #   @return [String, nil]
+      optional :event_id, String
+
       # @!attribute notes
-      #   Retrieve the notes from the Notification template settings.
+      #   Include template notes in the response. Only applies to legacy templates.
       #
       #   @return [Boolean, nil]
       optional :notes, Courier::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(cursor: nil, notes: nil, request_options: {})
-      #   @param cursor [String, nil]
+      # @!method initialize(cursor: nil, event_id: nil, notes: nil, request_options: {})
+      #   @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @param event_id [String] Filter to templates linked to this event map ID.
       #
-      #   @param notes [Boolean, nil] Retrieve the notes from the Notification template settings.
+      #   @param notes [Boolean, nil] Include template notes in the response. Only applies to legacy templates.
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/notification_list_response.rb

@@ -10,108 +10,123 @@ module Courier
       required :paging, -> { Courier::Paging }
 
       # @!attribute results
+      #   Notification templates in this workspace.
       #
-      #   @return [Array<Courier::Models::NotificationListResponse::Result>]
+      #   @return [Array<Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary>]
       required :results,
-               -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result] }
+               -> { Courier::Internal::Type::ArrayOf[union: Courier::Models::NotificationListResponse::Result] }
 
       # @!method initialize(paging:, results:)
       #   @param paging [Courier::Models::Paging]
-      #   @param results [Array<Courier::Models::NotificationListResponse::Result>]
-
-      class Result < Courier::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Integer]
-        required :created_at, Integer
-
-        # @!attribute event_ids
-        #   Array of event IDs associated with this notification
-        #
-        #   @return [Array<String>]
-        required :event_ids, Courier::Internal::Type::ArrayOf[String]
-
-        # @!attribute note
-        #
-        #   @return [String]
-        required :note, String
-
-        # @!attribute routing
-        #
-        #   @return [Courier::Models::MessageRouting]
-        required :routing, -> { Courier::MessageRouting }
-
-        # @!attribute topic_id
-        #
-        #   @return [String]
-        required :topic_id, String
-
-        # @!attribute updated_at
-        #
-        #   @return [Integer]
-        required :updated_at, Integer
-
-        # @!attribute tags
-        #
-        #   @return [Courier::Models::NotificationListResponse::Result::Tags, nil]
-        optional :tags, -> { Courier::Models::NotificationListResponse::Result::Tags }, nil?: true
-
-        # @!attribute title
-        #
-        #   @return [String, nil]
-        optional :title, String, nil?: true
-
-        # @!method initialize(id:, created_at:, event_ids:, note:, routing:, topic_id:, updated_at:, tags: nil, title: nil)
-        #   @param id [String]
-        #
-        #   @param created_at [Integer]
-        #
-        #   @param event_ids [Array<String>] Array of event IDs associated with this notification
-        #
-        #   @param note [String]
-        #
-        #   @param routing [Courier::Models::MessageRouting]
-        #
-        #   @param topic_id [String]
-        #
-        #   @param updated_at [Integer]
-        #
-        #   @param tags [Courier::Models::NotificationListResponse::Result::Tags, nil]
-        #
-        #   @param title [String, nil]
-
-        # @see Courier::Models::NotificationListResponse::Result#tags
-        class Tags < Courier::Internal::Type::BaseModel
-          # @!attribute data
-          #
-          #   @return [Array<Courier::Models::NotificationListResponse::Result::Tags::Data>]
-          required :data,
-                   -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result::Tags::Data] }
-
-          # @!method initialize(data:)
-          #   @param data [Array<Courier::Models::NotificationListResponse::Result::Tags::Data>]
-
-          class Data < Courier::Internal::Type::BaseModel
-            # @!attribute id
-            #
-            #   @return [String]
-            required :id, String
+      #
+      #   @param results [Array<Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary>] Notification templates in this workspace.
 
-            # @!attribute name
-            #
-            #   @return [String]
-            required :name, String
+      # V2 (CDS) template summary returned in list responses.
+      module Result
+        extend Courier::Internal::Type::Union
+
+        variant -> { Courier::Models::NotificationListResponse::Result::Notification }
+
+        # V2 (CDS) template summary returned in list responses.
+        variant -> { Courier::NotificationTemplateSummary }
+
+        class Notification < Courier::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute event_ids
+          #   Array of event IDs associated with this notification
+          #
+          #   @return [Array<String>]
+          required :event_ids, Courier::Internal::Type::ArrayOf[String]
+
+          # @!attribute note
+          #
+          #   @return [String]
+          required :note, String
+
+          # @!attribute routing
+          #
+          #   @return [Courier::Models::MessageRouting]
+          required :routing, -> { Courier::MessageRouting }
+
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
 
-            # @!method initialize(id:, name:)
-            #   @param id [String]
-            #   @param name [String]
+          # @!attribute updated_at
+          #
+          #   @return [Integer]
+          required :updated_at, Integer
+
+          # @!attribute tags
+          #
+          #   @return [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
+          optional :tags, -> { Courier::Models::NotificationListResponse::Result::Notification::Tags }, nil?: true
+
+          # @!attribute title
+          #
+          #   @return [String, nil]
+          optional :title, String, nil?: true
+
+          # @!method initialize(id:, created_at:, event_ids:, note:, routing:, topic_id:, updated_at:, tags: nil, title: nil)
+          #   @param id [String]
+          #
+          #   @param created_at [Integer]
+          #
+          #   @param event_ids [Array<String>] Array of event IDs associated with this notification
+          #
+          #   @param note [String]
+          #
+          #   @param routing [Courier::Models::MessageRouting]
+          #
+          #   @param topic_id [String]
+          #
+          #   @param updated_at [Integer]
+          #
+          #   @param tags [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
+          #
+          #   @param title [String, nil]
+
+          # @see Courier::Models::NotificationListResponse::Result::Notification#tags
+          class Tags < Courier::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Array<Courier::Models::NotificationListResponse::Result::Notification::Tags::Data>]
+            required :data,
+                     -> { Courier::Internal::Type::ArrayOf[Courier::Models::NotificationListResponse::Result::Notification::Tags::Data] }
+
+            # @!method initialize(data:)
+            #   @param data [Array<Courier::Models::NotificationListResponse::Result::Notification::Tags::Data>]
+
+            class Data < Courier::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!method initialize(id:, name:)
+              #   @param id [String]
+              #   @param name [String]
+            end
           end
         end
+
+        # @!method self.variants
+        #   @return [Array(Courier::Models::NotificationListResponse::Result::Notification, Courier::Models::NotificationTemplateSummary)]
       end
     end
   end

data/lib/courier/models/notification_list_versions_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#list_versions
+    class NotificationListVersionsParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Maximum number of versions to return per page. Default 10, max 10.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/courier/models/notification_locale_put_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationLocalePutRequest < Courier::Internal::Type::BaseModel
+      # @!attribute elements
+      #   Elements with locale-specific content overrides.
+      #
+      #   @return [Array<Courier::Models::NotificationLocalePutRequest::Element>]
+      required :elements,
+               -> { Courier::Internal::Type::ArrayOf[Courier::NotificationLocalePutRequest::Element] }
+
+      # @!attribute state
+      #   Template state. Defaults to `DRAFT`.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateState, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateState }
+
+      # @!method initialize(elements:, state: nil)
+      #   Request body for setting locale-specific content overrides. Each element
+      #   override must include the target element ID.
+      #
+      #   @param elements [Array<Courier::Models::NotificationLocalePutRequest::Element>] Elements with locale-specific content overrides.
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+
+      class Element < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #   Target element ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   @param id [String] Target element ID.
+      end
+    end
+  end
+end

data/lib/courier/models/notification_publish_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#publish
+    class NotificationPublishParams < Courier::Models::NotificationTemplatePublishRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_put_content_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_content
+    class NotificationPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_put_element_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_element
+    class NotificationPutElementParams < Courier::Models::NotificationElementPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute element_id
+      #
+      #   @return [String]
+      required :element_id, String
+
+      # @!method initialize(id:, element_id:, request_options: {})
+      #   @param id [String]
+      #   @param element_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_put_locale_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#put_locale
+    class NotificationPutLocaleParams < Courier::Models::NotificationLocalePutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute locale_id
+      #
+      #   @return [String]
+      required :locale_id, String
+
+      # @!method initialize(id:, locale_id:, request_options: {})
+      #   @param id [String]
+      #   @param locale_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_replace_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#replace
+    class NotificationReplaceParams < Courier::Models::NotificationTemplateUpdateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_retrieve_content_params.rb

@@ -12,8 +12,21 @@ module Courier
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute version
+      #   Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to
+      #   `published`.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(id:, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationRetrieveContentParams} for more details.
+      #
       #   @param id [String]
+      #
+      #   @param version [String] Accepts `draft`, `published`, or a version string (e.g., `v001`). Defaults to `p
+      #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/notification_retrieve_content_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # Elemental content response for V2 templates. Contains versioned elements with
+    # content checksums.
+    #
+    # @see Courier::Resources::Notifications#retrieve_content
+    module NotificationRetrieveContentResponse
+      extend Courier::Internal::Type::Union
+
+      # Elemental content response for V2 templates. Contains versioned elements with content checksums.
+      variant -> { Courier::NotificationContentGetResponse }
+
+      variant -> { Courier::NotificationGetContent }
+
+      # @!method self.variants
+      #   @return [Array(Courier::Models::NotificationContentGetResponse, Courier::Models::NotificationGetContent)]
+    end
+  end
+end

data/lib/courier/models/notification_retrieve_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#retrieve
+    class NotificationRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute version
+      #   Version to retrieve. One of "draft", "published", or a version string like
+      #   "v001". Defaults to "published".
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(id:, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationRetrieveParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param version [String] Version to retrieve. One of "draft", "published", or a version string like "v001
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/notification_template_create_request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class NotificationTemplateCreateRequest < Courier::Internal::Type::BaseModel
+      # @!attribute notification
+      #   Full document shape used in POST and PUT request bodies, and returned inside the
+      #   GET response envelope.
+      #
+      #   @return [Courier::Models::NotificationTemplatePayload]
+      required :notification, -> { Courier::NotificationTemplatePayload }
+
+      # @!attribute state
+      #   Template state after creation. Case-insensitive input, normalized to uppercase
+      #   in the response. Defaults to "DRAFT".
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateCreateRequest::State, nil]
+      optional :state, enum: -> { Courier::NotificationTemplateCreateRequest::State }
+
+      # @!method initialize(notification:, state: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::NotificationTemplateCreateRequest} for more details.
+      #
+      #   Request body for creating a notification template.
+      #
+      #   @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
+
+      # Template state after creation. Case-insensitive input, normalized to uppercase
+      # in the response. Defaults to "DRAFT".
+      #
+      # @see Courier::Models::NotificationTemplateCreateRequest#state
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end