trycourier 4.3.0 → 4.5.0

data/lib/trycourier/models/inbound_bulk_message.rb

@@ -2,124 +2,90 @@
 
 module Trycourier
   module Models
-    module InboundBulkMessage
-      extend Trycourier::Internal::Type::Union
-
-      variant -> { Trycourier::InboundBulkMessage::InboundBulkTemplateMessage }
-
-      variant -> { Trycourier::InboundBulkMessage::InboundBulkContentMessage }
-
-      class InboundBulkTemplateMessage < Trycourier::Internal::Type::BaseModel
-        # @!attribute template
-        #
-        #   @return [String]
-        required :template, String
-
-        # @!attribute brand
-        #
-        #   @return [String, nil]
-        optional :brand, String, nil?: true
-
-        # @!attribute data
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute event
-        #
-        #   @return [String, nil]
-        optional :event, String, nil?: true
-
-        # @!attribute locale
-        #
-        #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-        optional :locale,
-                 Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]],
-                 nil?: true
-
-        # @!attribute override
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override,
-                 Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
-                 nil?: true
-
-        # @!method initialize(template:, brand: nil, data: nil, event: nil, locale: nil, override: nil)
-        #   @param template [String]
-        #   @param brand [String, nil]
-        #   @param data [Hash{Symbol=>Object}, nil]
-        #   @param event [String, nil]
-        #   @param locale [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-        #   @param override [Hash{Symbol=>Object}, nil]
-      end
-
-      class InboundBulkContentMessage < Trycourier::Internal::Type::BaseModel
-        # @!attribute content
-        #   Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-        #
-        #   @return [Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent]
-        required :content, union: -> { Trycourier::InboundBulkMessage::InboundBulkContentMessage::Content }
-
-        # @!attribute brand
-        #
-        #   @return [String, nil]
-        optional :brand, String, nil?: true
-
-        # @!attribute data
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
-
-        # @!attribute event
-        #
-        #   @return [String, nil]
-        optional :event, String, nil?: true
-
-        # @!attribute locale
-        #
-        #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-        optional :locale,
-                 Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]],
-                 nil?: true
-
-        # @!attribute override
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :override,
-                 Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
-                 nil?: true
-
-        # @!method initialize(content:, brand: nil, data: nil, event: nil, locale: nil, override: nil)
-        #   @param content [Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent] Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-        #
-        #   @param brand [String, nil]
-        #
-        #   @param data [Hash{Symbol=>Object}, nil]
-        #
-        #   @param event [String, nil]
-        #
-        #   @param locale [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
-        #
-        #   @param override [Hash{Symbol=>Object}, nil]
+    class InboundBulkMessage < Trycourier::Internal::Type::BaseModel
+      # @!attribute event
+      #   Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+      #   "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+      #   mapped to a notification.
+      #
+      #   @return [String]
+      required :event, String
+
+      # @!attribute brand
+      #
+      #   @return [String, nil]
+      optional :brand, String, nil?: true
+
+      # @!attribute content
+      #   Elemental content (optional, for V2 format). When provided, this will be used
+      #   instead of the notification associated with the `event` field.
+      #
+      #   @return [Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent, nil]
+      optional :content, union: -> { Trycourier::InboundBulkMessage::Content }, nil?: true
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute locale
+      #
+      #   @return [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
+      optional :locale,
+               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]],
+               nil?: true
+
+      # @!attribute override
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :override, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute template
+      #   Notification ID or template ID (optional, for V2 format). When provided, this
+      #   will be used instead of the notification associated with the `event` field.
+      #
+      #   @return [String, nil]
+      optional :template, String, nil?: true
+
+      # @!method initialize(event:, brand: nil, content: nil, data: nil, locale: nil, override: nil, template: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::InboundBulkMessage} for more details.
+      #
+      #   Bulk message definition. Supports two formats:
+      #
+      #   - V1 format: Requires `event` field (event ID or notification ID)
+      #   - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+      #     content) in addition to `event`
+      #
+      #   @param event [String] Event ID or Notification ID (required). Can be either a
+      #
+      #   @param brand [String, nil]
+      #
+      #   @param content [Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent, nil] Elemental content (optional, for V2 format). When provided, this will be used
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #
+      #   @param locale [Hash{Symbol=>Hash{Symbol=>Object}}, nil]
+      #
+      #   @param override [Hash{Symbol=>Object}, nil]
+      #
+      #   @param template [String, nil] Notification ID or template ID (optional, for V2 format). When provided,
+
+      # Elemental content (optional, for V2 format). When provided, this will be used
+      # instead of the notification associated with the `event` field.
+      #
+      # @see Trycourier::Models::InboundBulkMessage#content
+      module Content
+        extend Trycourier::Internal::Type::Union
 
         # Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-        #
-        # @see Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage#content
-        module Content
-          extend Trycourier::Internal::Type::Union
+        variant -> { Trycourier::ElementalContentSugar }
 
-          # Syntactic sugar to provide a fast shorthand for Courier Elemental Blocks.
-          variant -> { Trycourier::ElementalContentSugar }
+        variant -> { Trycourier::ElementalContent }
 
-          variant -> { Trycourier::ElementalContent }
-
-          # @!method self.variants
-          #   @return [Array(Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent)]
-        end
+        # @!method self.variants
+        #   @return [Array(Trycourier::Models::ElementalContentSugar, Trycourier::Models::ElementalContent)]
       end
-
-      # @!method self.variants
-      #   @return [Array(Trycourier::Models::InboundBulkMessage::InboundBulkTemplateMessage, Trycourier::Models::InboundBulkMessage::InboundBulkContentMessage)]
     end
   end
 end

data/lib/trycourier/models/inbound_bulk_message_user.rb

@@ -4,6 +4,7 @@ module Trycourier
   module Models
     class InboundBulkMessageUser < Trycourier::Internal::Type::BaseModel
       # @!attribute data
+      #   User-specific data that will be merged with message.data
       #
       #   @return [Object, nil]
       optional :data, Trycourier::Internal::Type::Unknown
@@ -14,26 +15,40 @@ module Trycourier
       optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
 
       # @!attribute profile
+      #   User profile information. For email-based bulk jobs, `profile.email` is required
+      #   for provider routing to determine if the message can be delivered. The email
+      #   address should be provided here rather than in `to.email`.
       #
-      #   @return [Object, nil]
-      optional :profile, Trycourier::Internal::Type::Unknown
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
 
       # @!attribute recipient
+      #   User ID (legacy field, use profile or to.user_id instead)
       #
       #   @return [String, nil]
       optional :recipient, String, nil?: true
 
       # @!attribute to
+      #   Optional recipient information. Note: For email provider routing, use
+      #   `profile.email` instead of `to.email`. The `to` field is primarily used for
+      #   recipient identification and data merging.
       #
       #   @return [Trycourier::Models::UserRecipient, nil]
       optional :to, -> { Trycourier::UserRecipient }, nil?: true
 
       # @!method initialize(data: nil, preferences: nil, profile: nil, recipient: nil, to: nil)
-      #   @param data [Object]
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::InboundBulkMessageUser} for more details.
+      #
+      #   @param data [Object] User-specific data that will be merged with message.data
+      #
       #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
-      #   @param profile [Object]
-      #   @param recipient [String, nil]
-      #   @param to [Trycourier::Models::UserRecipient, nil]
+      #
+      #   @param profile [Hash{Symbol=>Object}, nil] User profile information. For email-based bulk jobs, `profile.email` is required
+      #
+      #   @param recipient [String, nil] User ID (legacy field, use profile or to.user_id instead)
+      #
+      #   @param to [Trycourier::Models::UserRecipient, nil] Optional recipient information. Note: For email provider routing, use
     end
   end
 end

data/lib/trycourier/models/intercom.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Intercom < Trycourier::Internal::Type::BaseModel
+      # @!attribute from
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute to
+      #
+      #   @return [Trycourier::Models::IntercomRecipient]
+      required :to, -> { Trycourier::IntercomRecipient }
+
+      # @!method initialize(from:, to:)
+      #   @param from [String]
+      #   @param to [Trycourier::Models::IntercomRecipient]
+    end
+  end
+end

data/lib/trycourier/models/intercom_recipient.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class IntercomRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String]
+    end
+  end
+end

data/lib/trycourier/models/list_filter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class ListFilter < Trycourier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   Send to users only if they are member of the account
+      #
+      #   @return [Symbol, Trycourier::Models::ListFilter::Operator]
+      required :operator, enum: -> { Trycourier::ListFilter::Operator }
+
+      # @!attribute path
+      #
+      #   @return [Symbol, Trycourier::Models::ListFilter::Path]
+      required :path, enum: -> { Trycourier::ListFilter::Path }
+
+      # @!attribute value
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(operator:, path:, value:)
+      #   @param operator [Symbol, Trycourier::Models::ListFilter::Operator] Send to users only if they are member of the account
+      #
+      #   @param path [Symbol, Trycourier::Models::ListFilter::Path]
+      #
+      #   @param value [String]
+
+      # Send to users only if they are member of the account
+      #
+      # @see Trycourier::Models::ListFilter#operator
+      module Operator
+        extend Trycourier::Internal::Type::Enum
+
+        MEMBER_OF = :MEMBER_OF
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Trycourier::Models::ListFilter#path
+      module Path
+        extend Trycourier::Internal::Type::Enum
+
+        ACCOUNT_ID = :account_id
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/list_pattern_recipient.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class ListPatternRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute list_pattern
+      #
+      #   @return [String, nil]
+      optional :list_pattern, String, nil?: true
+
+      # @!method initialize(data: nil, list_pattern: nil)
+      #   Send to users in lists matching a pattern
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #   @param list_pattern [String, nil]
+    end
+  end
+end

data/lib/trycourier/models/list_recipient.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class ListRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute filters
+      #
+      #   @return [Array<Trycourier::Models::ListFilter>, nil]
+      optional :filters, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::ListFilter] }, nil?: true
+
+      # @!attribute list_id
+      #
+      #   @return [String, nil]
+      optional :list_id, String, nil?: true
+
+      # @!method initialize(data: nil, filters: nil, list_id: nil)
+      #   Send to all users in a specific list
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #   @param filters [Array<Trycourier::Models::ListFilter>, nil]
+      #   @param list_id [String, nil]
+    end
+  end
+end

data/lib/trycourier/models/ms_teams.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module MsTeams
+      extend Trycourier::Internal::Type::Union
+
+      variant -> { Trycourier::SendToMsTeamsUserID }
+
+      variant -> { Trycourier::SendToMsTeamsEmail }
+
+      variant -> { Trycourier::SendToMsTeamsChannelID }
+
+      variant -> { Trycourier::SendToMsTeamsConversationID }
+
+      variant -> { Trycourier::SendToMsTeamsChannelName }
+
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SendToMsTeamsUserID, Trycourier::Models::SendToMsTeamsEmail, Trycourier::Models::SendToMsTeamsChannelID, Trycourier::Models::SendToMsTeamsConversationID, Trycourier::Models::SendToMsTeamsChannelName)]
+    end
+  end
+end

data/lib/trycourier/models/ms_teams_base_properties.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class MsTeamsBaseProperties < Trycourier::Internal::Type::BaseModel
+      # @!attribute service_url
+      #
+      #   @return [String]
+      required :service_url, String
+
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(service_url:, tenant_id:)
+      #   @param service_url [String]
+      #   @param tenant_id [String]
+    end
+  end
+end

data/lib/trycourier/models/ms_teams_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class MsTeamsRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute ms_teams
+      #
+      #   @return [Trycourier::Models::SendToMsTeamsUserID, Trycourier::Models::SendToMsTeamsEmail, Trycourier::Models::SendToMsTeamsChannelID, Trycourier::Models::SendToMsTeamsConversationID, Trycourier::Models::SendToMsTeamsChannelName]
+      required :ms_teams, union: -> { Trycourier::MsTeams }
+
+      # @!method initialize(ms_teams:)
+      #   Send via Microsoft Teams
+      #
+      #   @param ms_teams [Trycourier::Models::SendToMsTeamsUserID, Trycourier::Models::SendToMsTeamsEmail, Trycourier::Models::SendToMsTeamsChannelID, Trycourier::Models::SendToMsTeamsConversationID, Trycourier::Models::SendToMsTeamsChannelName]
+    end
+  end
+end

data/lib/trycourier/models/multiple_tokens.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class MultipleTokens < Trycourier::Internal::Type::BaseModel
+      # @!attribute tokens
+      #
+      #   @return [Array<Trycourier::Models::Token>]
+      required :tokens, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Token] }
+
+      # @!method initialize(tokens:)
+      #   @param tokens [Array<Trycourier::Models::Token>]
+    end
+  end
+end

data/lib/trycourier/models/nested_filter_config.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class NestedFilterConfig < Trycourier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   The operator to use for filtering
+      #
+      #   @return [Symbol, Trycourier::Models::NestedFilterConfig::Operator]
+      required :operator, enum: -> { Trycourier::NestedFilterConfig::Operator }
+
+      # @!attribute rules
+      #
+      #   @return [Array<Trycourier::Models::FilterConfig>]
+      required :rules, -> { Trycourier::Internal::Type::ArrayOf[union: Trycourier::FilterConfig] }
+
+      # @!method initialize(operator:, rules:)
+      #   @param operator [Symbol, Trycourier::Models::NestedFilterConfig::Operator] The operator to use for filtering
+      #
+      #   @param rules [Array<Trycourier::Models::FilterConfig>]
+
+      # The operator to use for filtering
+      #
+      # @see Trycourier::Models::NestedFilterConfig#operator
+      module Operator
+        extend Trycourier::Internal::Type::Enum
+
+        ENDS_WITH = :ENDS_WITH
+        EQ = :EQ
+        EXISTS = :EXISTS
+        GT = :GT
+        GTE = :GTE
+        INCLUDES = :INCLUDES
+        IS_AFTER = :IS_AFTER
+        IS_BEFORE = :IS_BEFORE
+        LT = :LT
+        LTE = :LTE
+        NEQ = :NEQ
+        OMIT = :OMIT
+        STARTS_WITH = :STARTS_WITH
+        AND = :AND
+        OR = :OR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/pagerduty.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Pagerduty < Trycourier::Internal::Type::BaseModel
+      # @!attribute event_action
+      #
+      #   @return [String, nil]
+      optional :event_action, String, nil?: true
+
+      # @!attribute routing_key
+      #
+      #   @return [String, nil]
+      optional :routing_key, String, nil?: true
+
+      # @!attribute severity
+      #
+      #   @return [String, nil]
+      optional :severity, String, nil?: true
+
+      # @!attribute source
+      #
+      #   @return [String, nil]
+      optional :source, String, nil?: true
+
+      # @!method initialize(event_action: nil, routing_key: nil, severity: nil, source: nil)
+      #   @param event_action [String, nil]
+      #   @param routing_key [String, nil]
+      #   @param severity [String, nil]
+      #   @param source [String, nil]
+    end
+  end
+end

data/lib/trycourier/models/pagerduty_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class PagerdutyRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute pagerduty
+      #
+      #   @return [Trycourier::Models::Pagerduty]
+      required :pagerduty, -> { Trycourier::Pagerduty }
+
+      # @!method initialize(pagerduty:)
+      #   Send via PagerDuty
+      #
+      #   @param pagerduty [Trycourier::Models::Pagerduty]
+    end
+  end
+end

data/lib/trycourier/models/send_direct_message.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SendDirectMessage < Trycourier::Internal::Type::BaseModel
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:)
+      #   @param user_id [String]
+    end
+  end
+end