trycourier 4.10.1 → 4.11.0

data/lib/courier/models/journey_throttle_dynamic_node.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyThrottleDynamicNode < Courier::Internal::Type::BaseModel
+      # @!attribute max_allowed
+      #
+      #   @return [Integer]
+      required :max_allowed, Integer
+
+      # @!attribute period
+      #
+      #   @return [String]
+      required :period, String
+
+      # @!attribute scope
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope]
+      required :scope, enum: -> { Courier::JourneyThrottleDynamicNode::Scope }
+
+      # @!attribute throttle_key
+      #
+      #   @return [String]
+      required :throttle_key, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleDynamicNode::Type]
+      required :type, enum: -> { Courier::JourneyThrottleDynamicNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute conditions
+      #   Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      #   group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      #   express "no conditions".
+      #
+      #   @return [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil]
+      optional :conditions, union: -> { Courier::JourneyConditionsField }
+
+      # @!method initialize(max_allowed:, period:, scope:, throttle_key:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyThrottleDynamicNode} for more details.
+      #
+      #   Throttle the journey by a dynamic `throttle_key`, allowing at most `max_allowed`
+      #   invocations per `period`.
+      #
+      #   @param max_allowed [Integer]
+      #
+      #   @param period [String]
+      #
+      #   @param scope [Symbol, Courier::Models::JourneyThrottleDynamicNode::Scope]
+      #
+      #   @param throttle_key [String]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyThrottleDynamicNode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @param conditions [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup] Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr
+
+      # @see Courier::Models::JourneyThrottleDynamicNode#scope
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        DYNAMIC = :dynamic
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyThrottleDynamicNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE = :throttle
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_throttle_static_node.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyThrottleStaticNode < Courier::Internal::Type::BaseModel
+      # @!attribute max_allowed
+      #
+      #   @return [Integer]
+      required :max_allowed, Integer
+
+      # @!attribute period
+      #
+      #   @return [String]
+      required :period, String
+
+      # @!attribute scope
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleStaticNode::Scope]
+      required :scope, enum: -> { Courier::JourneyThrottleStaticNode::Scope }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Courier::Models::JourneyThrottleStaticNode::Type]
+      required :type, enum: -> { Courier::JourneyThrottleStaticNode::Type }
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute conditions
+      #   Condition spec for a journey node. Accepts a single condition atom, an AND/OR
+      #   group, or an AND/OR nested group. Omit the `conditions` property entirely to
+      #   express "no conditions".
+      #
+      #   @return [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup, nil]
+      optional :conditions, union: -> { Courier::JourneyConditionsField }
+
+      # @!method initialize(max_allowed:, period:, scope:, type:, id: nil, conditions: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::JourneyThrottleStaticNode} for more details.
+      #
+      #   Throttle the journey by a static `scope` (`user` or `global`), allowing at most
+      #   `max_allowed` invocations per `period`.
+      #
+      #   @param max_allowed [Integer]
+      #
+      #   @param period [String]
+      #
+      #   @param scope [Symbol, Courier::Models::JourneyThrottleStaticNode::Scope]
+      #
+      #   @param type [Symbol, Courier::Models::JourneyThrottleStaticNode::Type]
+      #
+      #   @param id [String]
+      #
+      #   @param conditions [Array<String>, Courier::Models::JourneyConditionGroup, Courier::Models::JourneyConditionNestedGroup] Condition spec for a journey node. Accepts a single condition atom, an AND/OR gr
+
+      # @see Courier::Models::JourneyThrottleStaticNode#scope
+      module Scope
+        extend Courier::Internal::Type::Enum
+
+        USER = :user
+        GLOBAL = :global
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::JourneyThrottleStaticNode#type
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        THROTTLE = :throttle
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/journey_version_item.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class JourneyVersionItem < Courier::Internal::Type::BaseModel
+      # @!attribute created
+      #
+      #   @return [Integer, nil]
+      required :created, Integer, nil?: true
+
+      # @!attribute creator
+      #
+      #   @return [String, nil]
+      required :creator, String, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute published
+      #
+      #   @return [Integer, nil]
+      required :published, Integer, nil?: true
+
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(created:, creator:, name:, published:, version:)
+      #   A published version of a journey.
+      #
+      #   @param created [Integer, nil]
+      #   @param creator [String, nil]
+      #   @param name [String]
+      #   @param published [Integer, nil]
+      #   @param version [String]
+    end
+  end
+end

data/lib/courier/models/journey_versions_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Journeys#list_versions
+    class JourneyVersionsListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::JourneyVersionItem>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::JourneyVersionItem] }
+
+      # @!method initialize(paging:, results:)
+      #   Paged list of published journey versions, most recent first.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::JourneyVersionItem>]
+    end
+  end
+end

data/lib/courier/models/journeys/template_archive_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#archive
+      class TemplateArchiveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#create
+      class TemplateCreateParams < Courier::Models::JourneyTemplateCreateRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(template_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_list_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#list
+      class TemplateListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute cursor
+        #   Pagination cursor from a prior response.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #   Page size. Minimum 1, maximum 100.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(template_id:, cursor: nil, limit: nil, request_options: {})
+        #   @param template_id [String]
+        #
+        #   @param cursor [String] Pagination cursor from a prior response.
+        #
+        #   @param limit [Integer] Page size. Minimum 1, maximum 100.
+        #
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_list_versions_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#list_versions
+      class TemplateListVersionsParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_publish_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#publish
+      class TemplatePublishParams < Courier::Models::JourneyTemplatePublishRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_replace_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#replace
+      class TemplateReplaceParams < Courier::Models::JourneyTemplateReplaceRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/journeys/template_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Journeys
+      # @see Courier::Resources::Journeys::Templates#retrieve
+      class TemplateRetrieveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!attribute notification_id
+        #
+        #   @return [String]
+        required :notification_id, String
+
+        # @!method initialize(template_id:, notification_id:, request_options: {})
+        #   @param template_id [String]
+        #   @param notification_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_list_response.rb

@@ -47,11 +47,6 @@ module Courier
           #   @return [Array<String>]
           required :event_ids, Courier::Internal::Type::ArrayOf[String]
 
-          # @!attribute note
-          #
-          #   @return [String]
-          required :note, String
-
           # @!attribute routing
           #
           #   @return [Courier::Models::MessageRouting]
@@ -67,6 +62,11 @@ module Courier
           #   @return [Integer]
           required :updated_at, Integer
 
+          # @!attribute note
+          #
+          #   @return [String, nil]
+          optional :note, String
+
           # @!attribute tags
           #
           #   @return [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
@@ -77,21 +77,21 @@ module Courier
           #   @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)
+          # @!method initialize(id:, created_at:, event_ids:, routing:, topic_id:, updated_at:, note: nil, 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 note [String]
+          #
           #   @param tags [Courier::Models::NotificationListResponse::Result::Notification::Tags, nil]
           #
           #   @param title [String, nil]

data/lib/courier/models/notification_template_create_request.rb

@@ -4,8 +4,8 @@ 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.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @return [Courier::Models::NotificationTemplatePayload]
       required :notification, -> { Courier::NotificationTemplatePayload }
@@ -23,7 +23,7 @@ module Courier
       #
       #   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 notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       #   @param state [Symbol, Courier::Models::NotificationTemplateCreateRequest::State] Template state after creation. Case-insensitive input, normalized to uppercase i
 

data/lib/courier/models/notification_template_payload.rb

@@ -40,8 +40,8 @@ module Courier
       required :tags, Courier::Internal::Type::ArrayOf[String]
 
       # @!method initialize(brand:, content:, name:, routing:, subscription:, tags:)
-      #   Full document shape used in POST and PUT request bodies, and returned inside the
-      #   GET response envelope.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @param brand [Courier::Models::NotificationTemplatePayload::Brand, nil] Brand reference, or null for no brand.
       #

data/lib/courier/models/notification_template_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Notifications#create
+    class NotificationTemplateResponse < Courier::Models::NotificationTemplatePayload
+      # @!attribute id
+      #   The template ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Epoch milliseconds when the template was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute state
+      #   The template state. Always uppercase.
+      #
+      #   @return [Symbol, Courier::Models::NotificationTemplateResponse::State]
+      required :state, enum: -> { Courier::NotificationTemplateResponse::State }
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String
+
+      # @!method initialize(id:, created:, creator:, state:, updated: nil, updater: nil)
+      #   Response for GET /notifications/{id}, POST /notifications, and PUT
+      #   /notifications/{id}. Returns all template fields at the top level.
+      #
+      #   @param id [String] The template ID.
+      #
+      #   @param created [Integer] Epoch milliseconds when the template was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param state [Symbol, Courier::Models::NotificationTemplateResponse::State] The template state. Always uppercase.
+      #
+      #   @param updated [Integer] Epoch milliseconds of last update.
+      #
+      #   @param updater [String] User ID of the last updater.
+
+      # The template state. Always uppercase.
+      module State
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        PUBLISHED = :PUBLISHED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/notification_template_update_request.rb

@@ -4,8 +4,8 @@ module Courier
   module Models
     class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
       # @!attribute notification
-      #   Full document shape used in POST and PUT request bodies, and returned inside the
-      #   GET response envelope.
+      #   Core template fields used in POST and PUT request bodies (nested under a
+      #   `notification` key) and returned at the top level in responses.
       #
       #   @return [Courier::Models::NotificationTemplatePayload]
       required :notification, -> { Courier::NotificationTemplatePayload }
@@ -24,7 +24,7 @@ module Courier
       #   Request body for replacing a notification template. Same shape as create. All
       #   fields required (PUT = full replacement).
       #
-      #   @param notification [Courier::Models::NotificationTemplatePayload] Full document shape used in POST and PUT request bodies, and returned inside the
+      #   @param notification [Courier::Models::NotificationTemplatePayload] Core template fields used in POST and PUT request bodies (nested under a `notifi
       #
       #   @param state [Symbol, Courier::Models::NotificationTemplateUpdateRequest::State] Template state after update. Case-insensitive input, normalized to uppercase in
 

data/lib/courier/models/tenants/template_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Tenants
+      # @see Courier::Resources::Tenants::Templates#delete
+      class TemplateDeleteParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
+        #   @param tenant_id [String]
+        #   @param template_id [String]
+        #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end