trycourier 4.4.0 → 4.5.0

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

data/lib/trycourier/models/send_message_params.rb

@@ -100,7 +100,7 @@ module Trycourier
         # @!attribute to
         #   The recipient or a list of recipients of the message
         #
-        #   @return [Trycourier::Models::UserRecipient, Array<Trycourier::Models::Recipient>, nil]
+        #   @return [Trycourier::Models::UserRecipient, Trycourier::Models::AudienceRecipient, Trycourier::Models::ListRecipient, Trycourier::Models::ListPatternRecipient, Trycourier::Models::SlackRecipient, Trycourier::Models::MsTeamsRecipient, Trycourier::Models::PagerdutyRecipient, Trycourier::Models::WebhookRecipient, nil]
         optional :to, union: -> { Trycourier::SendMessageParams::Message::To }, nil?: true
 
         # @!method initialize(brand_id: nil, channels: nil, content: nil, context: nil, data: nil, delay: nil, expiry: nil, metadata: nil, preferences: nil, providers: nil, routing: nil, template: nil, timeout: nil, to: nil)
@@ -136,7 +136,7 @@ module Trycourier
         #
         #   @param timeout [Trycourier::Models::SendMessageParams::Message::Timeout, nil]
         #
-        #   @param to [Trycourier::Models::UserRecipient, Array<Trycourier::Models::Recipient>, nil] The recipient or a list of recipients of the message
+        #   @param to [Trycourier::Models::UserRecipient, Trycourier::Models::AudienceRecipient, Trycourier::Models::ListRecipient, Trycourier::Models::ListPatternRecipient, Trycourier::Models::SlackRecipient, Trycourier::Models::MsTeamsRecipient, Trycourier::Models::PagerdutyRecipient, Trycourier::Models::WebhookRecipient, nil] The recipient or a list of recipients of the message
 
         class Channel < Trycourier::Internal::Type::BaseModel
           # @!attribute brand_id
@@ -504,15 +504,32 @@ module Trycourier
         module To
           extend Trycourier::Internal::Type::Union
 
+          # Send to a specific user by user_id, email, phone_number, or list_id
           variant -> { Trycourier::UserRecipient }
 
-          variant -> { Trycourier::Models::SendMessageParams::Message::To::RecipientArray }
+          # Send to all users in an audience
+          variant -> { Trycourier::AudienceRecipient }
 
-          # @!method self.variants
-          #   @return [Array(Trycourier::Models::UserRecipient, Array<Trycourier::Models::Recipient>)]
+          # Send to all users in a specific list
+          variant -> { Trycourier::ListRecipient }
+
+          # Send to users in lists matching a pattern
+          variant -> { Trycourier::ListPatternRecipient }
+
+          # Send via Slack (channel, email, or user_id)
+          variant -> { Trycourier::SlackRecipient }
+
+          # Send via Microsoft Teams
+          variant -> { Trycourier::MsTeamsRecipient }
 
-          # @type [Trycourier::Internal::Type::Converter]
-          RecipientArray = Trycourier::Internal::Type::ArrayOf[-> { Trycourier::Recipient }]
+          # Send via PagerDuty
+          variant -> { Trycourier::PagerdutyRecipient }
+
+          # Send via webhook
+          variant -> { Trycourier::WebhookRecipient }
+
+          # @!method self.variants
+          #   @return [Array(Trycourier::Models::UserRecipient, Trycourier::Models::AudienceRecipient, Trycourier::Models::ListRecipient, Trycourier::Models::ListPatternRecipient, Trycourier::Models::SlackRecipient, Trycourier::Models::MsTeamsRecipient, Trycourier::Models::PagerdutyRecipient, Trycourier::Models::WebhookRecipient)]
         end
       end
     end

data/lib/trycourier/models/send_to_channel.rb

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

data/lib/trycourier/models/send_to_ms_teams_channel_id.rb

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

data/lib/trycourier/models/send_to_ms_teams_channel_name.rb

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

data/lib/trycourier/models/send_to_ms_teams_conversation_id.rb

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

data/lib/trycourier/models/send_to_ms_teams_email.rb

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

data/lib/trycourier/models/send_to_ms_teams_user_id.rb

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

data/lib/trycourier/models/send_to_slack_channel.rb

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

data/lib/trycourier/models/send_to_slack_email.rb

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

data/lib/trycourier/models/send_to_slack_user_id.rb

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

data/lib/trycourier/models/single_filter_config.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SingleFilterConfig < Trycourier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   The operator to use for filtering
+      #
+      #   @return [Symbol, Trycourier::Models::SingleFilterConfig::Operator]
+      required :operator, enum: -> { Trycourier::SingleFilterConfig::Operator }
+
+      # @!attribute path
+      #   The attribe name from profile whose value will be operated against the filter
+      #   value
+      #
+      #   @return [String]
+      required :path, String
+
+      # @!attribute value
+      #   The value to use for filtering
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(operator:, path:, value:)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::SingleFilterConfig} for more details.
+      #
+      #   @param operator [Symbol, Trycourier::Models::SingleFilterConfig::Operator] The operator to use for filtering
+      #
+      #   @param path [String] The attribe name from profile whose value will be operated against the filter va
+      #
+      #   @param value [String] The value to use for filtering
+
+      # The operator to use for filtering
+      #
+      # @see Trycourier::Models::SingleFilterConfig#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/slack.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Slack
+      extend Trycourier::Internal::Type::Union
+
+      variant -> { Trycourier::SendToSlackChannel }
+
+      variant -> { Trycourier::SendToSlackEmail }
+
+      variant -> { Trycourier::SendToSlackUserID }
+
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID)]
+    end
+  end
+end

data/lib/trycourier/models/slack_base_properties.rb

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

data/lib/trycourier/models/slack_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SlackRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute slack
+      #
+      #   @return [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID]
+      required :slack, union: -> { Trycourier::Slack }
+
+      # @!method initialize(slack:)
+      #   Send via Slack (channel, email, or user_id)
+      #
+      #   @param slack [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID]
+    end
+  end
+end

data/lib/trycourier/models/token.rb

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