trycourier 4.3.0 → 4.5.0

data/rbi/trycourier/models.rbi

@@ -1,16 +1,24 @@
 # typed: strong
 
 module Trycourier
+  AirshipProfile = Trycourier::Models::AirshipProfile
+
+  AirshipProfileAudience = Trycourier::Models::AirshipProfileAudience
+
   Alignment = Trycourier::Models::Alignment
 
   Audience = Trycourier::Models::Audience
 
   AudienceDeleteParams = Trycourier::Models::AudienceDeleteParams
 
+  AudienceFilter = Trycourier::Models::AudienceFilter
+
   AudienceListMembersParams = Trycourier::Models::AudienceListMembersParams
 
   AudienceListParams = Trycourier::Models::AudienceListParams
 
+  AudienceRecipient = Trycourier::Models::AudienceRecipient
+
   AudienceRetrieveParams = Trycourier::Models::AudienceRetrieveParams
 
   AudienceUpdateParams = Trycourier::Models::AudienceUpdateParams
@@ -76,6 +84,10 @@ module Trycourier
 
   DefaultPreferences = Trycourier::Models::DefaultPreferences
 
+  DeviceType = Trycourier::Models::DeviceType
+
+  Discord = Trycourier::Models::Discord
+
   ElementalActionNodeWithType = Trycourier::Models::ElementalActionNodeWithType
 
   ElementalBaseNode = Trycourier::Models::ElementalBaseNode
@@ -108,6 +120,8 @@ module Trycourier
 
   EmailHeader = Trycourier::Models::EmailHeader
 
+  Expo = Trycourier::Models::Expo
+
   Filter = Trycourier::Models::Filter
 
   FilterConfig = Trycourier::Models::FilterConfig
@@ -120,10 +134,20 @@ module Trycourier
 
   InboundTrackEventParams = Trycourier::Models::InboundTrackEventParams
 
+  Intercom = Trycourier::Models::Intercom
+
+  IntercomRecipient = Trycourier::Models::IntercomRecipient
+
   ListDeleteParams = Trycourier::Models::ListDeleteParams
 
+  ListFilter = Trycourier::Models::ListFilter
+
   ListListParams = Trycourier::Models::ListListParams
 
+  ListPatternRecipient = Trycourier::Models::ListPatternRecipient
+
+  ListRecipient = Trycourier::Models::ListRecipient
+
   ListRestoreParams = Trycourier::Models::ListRestoreParams
 
   ListRetrieveParams = Trycourier::Models::ListRetrieveParams
@@ -152,6 +176,16 @@ module Trycourier
 
   MessageRoutingChannel = Trycourier::Models::MessageRoutingChannel
 
+  MsTeams = Trycourier::Models::MsTeams
+
+  MsTeamsBaseProperties = Trycourier::Models::MsTeamsBaseProperties
+
+  MsTeamsRecipient = Trycourier::Models::MsTeamsRecipient
+
+  MultipleTokens = Trycourier::Models::MultipleTokens
+
+  NestedFilterConfig = Trycourier::Models::NestedFilterConfig
+
   NotificationGetContent = Trycourier::Models::NotificationGetContent
 
   NotificationListParams = Trycourier::Models::NotificationListParams
@@ -164,6 +198,10 @@ module Trycourier
 
   Notifications = Trycourier::Models::Notifications
 
+  Pagerduty = Trycourier::Models::Pagerduty
+
+  PagerdutyRecipient = Trycourier::Models::PagerdutyRecipient
+
   Paging = Trycourier::Models::Paging
 
   Preference = Trycourier::Models::Preference
@@ -184,16 +222,42 @@ module Trycourier
 
   PutSubscriptionsRecipient = Trycourier::Models::PutSubscriptionsRecipient
 
-  Recipient = Trycourier::Models::Recipient
-
   RecipientPreferences = Trycourier::Models::RecipientPreferences
 
   RequestArchiveParams = Trycourier::Models::RequestArchiveParams
 
   Rule = Trycourier::Models::Rule
 
+  SendDirectMessage = Trycourier::Models::SendDirectMessage
+
   SendMessageParams = Trycourier::Models::SendMessageParams
 
+  SendToChannel = Trycourier::Models::SendToChannel
+
+  SendToMsTeamsChannelID = Trycourier::Models::SendToMsTeamsChannelID
+
+  SendToMsTeamsChannelName = Trycourier::Models::SendToMsTeamsChannelName
+
+  SendToMsTeamsConversationID = Trycourier::Models::SendToMsTeamsConversationID
+
+  SendToMsTeamsEmail = Trycourier::Models::SendToMsTeamsEmail
+
+  SendToMsTeamsUserID = Trycourier::Models::SendToMsTeamsUserID
+
+  SendToSlackChannel = Trycourier::Models::SendToSlackChannel
+
+  SendToSlackEmail = Trycourier::Models::SendToSlackEmail
+
+  SendToSlackUserID = Trycourier::Models::SendToSlackUserID
+
+  SingleFilterConfig = Trycourier::Models::SingleFilterConfig
+
+  Slack = Trycourier::Models::Slack
+
+  SlackBaseProperties = Trycourier::Models::SlackBaseProperties
+
+  SlackRecipient = Trycourier::Models::SlackRecipient
+
   SubscribeToListsRequestItem = Trycourier::Models::SubscribeToListsRequestItem
 
   SubscriptionList = Trycourier::Models::SubscriptionList
@@ -218,15 +282,33 @@ module Trycourier
 
   TextStyle = Trycourier::Models::TextStyle
 
+  Token = Trycourier::Models::Token
+
   TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
 
   TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
 
+  UserProfile = Trycourier::Models::UserProfile
+
+  UserProfileFirebaseToken = Trycourier::Models::UserProfileFirebaseToken
+
   UserRecipient = Trycourier::Models::UserRecipient
 
   Users = Trycourier::Models::Users
 
   Utm = Trycourier::Models::Utm
 
+  WebhookAuthentication = Trycourier::Models::WebhookAuthentication
+
+  WebhookAuthMode = Trycourier::Models::WebhookAuthMode
+
+  WebhookMethod = Trycourier::Models::WebhookMethod
+
+  WebhookProfile = Trycourier::Models::WebhookProfile
+
+  WebhookProfileType = Trycourier::Models::WebhookProfileType
+
+  WebhookRecipient = Trycourier::Models::WebhookRecipient
+
   WidgetBackground = Trycourier::Models::WidgetBackground
 end

data/rbi/trycourier/resources/audiences.rbi

@@ -22,7 +22,13 @@ module Trycourier
         params(
           audience_id: String,
           description: T.nilable(String),
-          filter: T.nilable(Trycourier::Filter::OrHash),
+          filter:
+            T.nilable(
+              T.any(
+                Trycourier::SingleFilterConfig::OrHash,
+                Trycourier::NestedFilterConfig::OrHash
+              )
+            ),
           name: T.nilable(String),
           request_options: Trycourier::RequestOptions::OrHash
         ).returns(Trycourier::Models::AudienceUpdateResponse)

data/rbi/trycourier/resources/bulk.rbi

@@ -3,7 +3,11 @@
 module Trycourier
   module Resources
     class Bulk
-      # Ingest user data into a Bulk Job
+      # Ingest user data into a Bulk Job.
+      #
+      # **Important**: For email-based bulk jobs, each user must include `profile.email`
+      # for provider routing to work correctly. The `to.email` field is not sufficient
+      # for email provider routing.
       sig do
         params(
           job_id: String,
@@ -19,18 +23,28 @@ module Trycourier
       )
       end
 
-      # Create a bulk job
+      # Creates a new bulk job for sending messages to multiple recipients.
+      #
+      # **Required**: `message.event` (event ID or notification ID)
+      #
+      # **Optional (V2 format)**: `message.template` (notification ID) or
+      # `message.content` (Elemental content) can be provided to override the
+      # notification associated with the event.
       sig do
         params(
-          message:
-            T.any(
-              Trycourier::InboundBulkMessage::InboundBulkTemplateMessage::OrHash,
-              Trycourier::InboundBulkMessage::InboundBulkContentMessage::OrHash
-            ),
+          message: Trycourier::InboundBulkMessage::OrHash,
           request_options: Trycourier::RequestOptions::OrHash
         ).returns(Trycourier::Models::BulkCreateJobResponse)
       end
-      def create_job(message:, request_options: {})
+      def create_job(
+        # 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`
+        message:,
+        request_options: {}
+      )
       end
 
       # Get Bulk Job Users

data/sig/trycourier/models/airship_profile.rbs

@@ -0,0 +1,25 @@
+module Trycourier
+  module Models
+    type airship_profile =
+      {
+        audience: Trycourier::AirshipProfileAudience,
+        device_types: ::Array[String]
+      }
+
+    class AirshipProfile < Trycourier::Internal::Type::BaseModel
+      attr_accessor audience: Trycourier::AirshipProfileAudience
+
+      attr_accessor device_types: ::Array[String]
+
+      def initialize: (
+        audience: Trycourier::AirshipProfileAudience,
+        device_types: ::Array[String]
+      ) -> void
+
+      def to_hash: -> {
+        audience: Trycourier::AirshipProfileAudience,
+        device_types: ::Array[String]
+      }
+    end
+  end
+end

data/sig/trycourier/models/airship_profile_audience.rbs

@@ -0,0 +1,13 @@
+module Trycourier
+  module Models
+    type airship_profile_audience = { named_user: String }
+
+    class AirshipProfileAudience < Trycourier::Internal::Type::BaseModel
+      attr_accessor named_user: String
+
+      def initialize: (named_user: String) -> void
+
+      def to_hash: -> { named_user: String }
+    end
+  end
+end

data/sig/trycourier/models/audience.rbs

@@ -5,7 +5,7 @@ module Trycourier
         id: String,
         created_at: String,
         description: String,
-        filter: Trycourier::Filter,
+        filter: Trycourier::Models::filter,
         name: String,
         updated_at: String
       }
@@ -17,7 +17,7 @@ module Trycourier
 
       attr_accessor description: String
 
-      attr_accessor filter: Trycourier::Filter
+      attr_accessor filter: Trycourier::Models::filter
 
       attr_accessor name: String
 
@@ -27,7 +27,7 @@ module Trycourier
         id: String,
         created_at: String,
         description: String,
-        filter: Trycourier::Filter,
+        filter: Trycourier::Models::filter,
         name: String,
         updated_at: String
       ) -> void
@@ -36,7 +36,7 @@ module Trycourier
         id: String,
         created_at: String,
         description: String,
-        filter: Trycourier::Filter,
+        filter: Trycourier::Models::filter,
         name: String,
         updated_at: String
       }

data/sig/trycourier/models/audience_filter.rbs

@@ -0,0 +1,50 @@
+module Trycourier
+  module Models
+    type audience_filter =
+      {
+        operator: Trycourier::Models::AudienceFilter::operator,
+        path: Trycourier::Models::AudienceFilter::path,
+        value: String
+      }
+
+    class AudienceFilter < Trycourier::Internal::Type::BaseModel
+      attr_accessor operator: Trycourier::Models::AudienceFilter::operator
+
+      attr_accessor path: Trycourier::Models::AudienceFilter::path
+
+      attr_accessor value: String
+
+      def initialize: (
+        operator: Trycourier::Models::AudienceFilter::operator,
+        path: Trycourier::Models::AudienceFilter::path,
+        value: String
+      ) -> void
+
+      def to_hash: -> {
+        operator: Trycourier::Models::AudienceFilter::operator,
+        path: Trycourier::Models::AudienceFilter::path,
+        value: String
+      }
+
+      type operator = :MEMBER_OF
+
+      module Operator
+        extend Trycourier::Internal::Type::Enum
+
+        MEMBER_OF: :MEMBER_OF
+
+        def self?.values: -> ::Array[Trycourier::Models::AudienceFilter::operator]
+      end
+
+      type path = :account_id
+
+      module Path
+        extend Trycourier::Internal::Type::Enum
+
+        ACCOUNT_ID: :account_id
+
+        def self?.values: -> ::Array[Trycourier::Models::AudienceFilter::path]
+      end
+    end
+  end
+end

data/sig/trycourier/models/audience_recipient.rbs

@@ -0,0 +1,30 @@
+module Trycourier
+  module Models
+    type audience_recipient =
+      {
+        audience_id: String,
+        data: ::Hash[Symbol, top]?,
+        filters: ::Array[Trycourier::AudienceFilter]?
+      }
+
+    class AudienceRecipient < Trycourier::Internal::Type::BaseModel
+      attr_accessor audience_id: String
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor filters: ::Array[Trycourier::AudienceFilter]?
+
+      def initialize: (
+        audience_id: String,
+        ?data: ::Hash[Symbol, top]?,
+        ?filters: ::Array[Trycourier::AudienceFilter]?
+      ) -> void
+
+      def to_hash: -> {
+        audience_id: String,
+        data: ::Hash[Symbol, top]?,
+        filters: ::Array[Trycourier::AudienceFilter]?
+      }
+    end
+  end
+end

data/sig/trycourier/models/audience_update_params.rbs

@@ -1,7 +1,11 @@
 module Trycourier
   module Models
     type audience_update_params =
-      { description: String?, filter: Trycourier::Filter?, name: String? }
+      {
+        description: String?,
+        filter: Trycourier::Models::filter?,
+        name: String?
+      }
       & Trycourier::Internal::Type::request_parameters
 
     class AudienceUpdateParams < Trycourier::Internal::Type::BaseModel
@@ -10,20 +14,20 @@ module Trycourier
 
       attr_accessor description: String?
 
-      attr_accessor filter: Trycourier::Filter?
+      attr_accessor filter: Trycourier::Models::filter?
 
       attr_accessor name: String?
 
       def initialize: (
         ?description: String?,
-        ?filter: Trycourier::Filter?,
+        ?filter: Trycourier::Models::filter?,
         ?name: String?,
         ?request_options: Trycourier::request_opts
       ) -> void
 
       def to_hash: -> {
         description: String?,
-        filter: Trycourier::Filter?,
+        filter: Trycourier::Models::filter?,
         name: String?,
         request_options: Trycourier::RequestOptions
       }

data/sig/trycourier/models/bulk_create_job_params.rbs

@@ -1,22 +1,22 @@
 module Trycourier
   module Models
     type bulk_create_job_params =
-      { message: Trycourier::Models::inbound_bulk_message }
+      { message: Trycourier::InboundBulkMessage }
       & Trycourier::Internal::Type::request_parameters
 
     class BulkCreateJobParams < Trycourier::Internal::Type::BaseModel
       extend Trycourier::Internal::Type::RequestParameters::Converter
       include Trycourier::Internal::Type::RequestParameters
 
-      attr_accessor message: Trycourier::Models::inbound_bulk_message
+      attr_accessor message: Trycourier::InboundBulkMessage
 
       def initialize: (
-        message: Trycourier::Models::inbound_bulk_message,
+        message: Trycourier::InboundBulkMessage,
         ?request_options: Trycourier::request_opts
       ) -> void
 
       def to_hash: -> {
-        message: Trycourier::Models::inbound_bulk_message,
+        message: Trycourier::InboundBulkMessage,
         request_options: Trycourier::RequestOptions
       }
     end

data/sig/trycourier/models/bulk_retrieve_job_response.rbs

@@ -14,7 +14,7 @@ module Trycourier
 
       type job =
         {
-          definition: Trycourier::Models::inbound_bulk_message,
+          definition: Trycourier::InboundBulkMessage,
           enqueued: Integer,
           failures: Integer,
           received: Integer,
@@ -22,7 +22,7 @@ module Trycourier
         }
 
       class Job < Trycourier::Internal::Type::BaseModel
-        attr_accessor definition: Trycourier::Models::inbound_bulk_message
+        attr_accessor definition: Trycourier::InboundBulkMessage
 
         attr_accessor enqueued: Integer
 
@@ -33,7 +33,7 @@ module Trycourier
         attr_accessor status: Trycourier::Models::BulkRetrieveJobResponse::Job::status
 
         def initialize: (
-          definition: Trycourier::Models::inbound_bulk_message,
+          definition: Trycourier::InboundBulkMessage,
           enqueued: Integer,
           failures: Integer,
           received: Integer,
@@ -41,7 +41,7 @@ module Trycourier
         ) -> void
 
         def to_hash: -> {
-          definition: Trycourier::Models::inbound_bulk_message,
+          definition: Trycourier::InboundBulkMessage,
           enqueued: Integer,
           failures: Integer,
           received: Integer,

data/sig/trycourier/models/device_type.rbs

@@ -0,0 +1,5 @@
+module Trycourier
+  module Models
+    class DeviceType = String
+  end
+end

data/sig/trycourier/models/discord.rbs

@@ -0,0 +1,11 @@
+module Trycourier
+  module Models
+    type discord = Trycourier::SendToChannel | Trycourier::SendDirectMessage
+
+    module Discord
+      extend Trycourier::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Trycourier::Models::discord]
+    end
+  end
+end

data/sig/trycourier/models/expo.rbs

@@ -0,0 +1,11 @@
+module Trycourier
+  module Models
+    type expo = Trycourier::Token | Trycourier::MultipleTokens
+
+    module Expo
+      extend Trycourier::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Trycourier::Models::expo]
+    end
+  end
+end

data/sig/trycourier/models/filter.rbs

@@ -1,69 +1,12 @@
 module Trycourier
   module Models
     type filter =
-      {
-        operator: Trycourier::Models::Filter::operator,
-        path: String,
-        value: String
-      }
+      Trycourier::SingleFilterConfig | Trycourier::NestedFilterConfig
 
-    class Filter < Trycourier::Internal::Type::BaseModel
-      attr_accessor operator: Trycourier::Models::Filter::operator
+    module Filter
+      extend Trycourier::Internal::Type::Union
 
-      attr_accessor path: String
-
-      attr_accessor value: String
-
-      def initialize: (
-        operator: Trycourier::Models::Filter::operator,
-        path: String,
-        value: String
-      ) -> void
-
-      def to_hash: -> {
-        operator: Trycourier::Models::Filter::operator,
-        path: String,
-        value: String
-      }
-
-      type operator =
-        :ENDS_WITH
-        | :EQ
-        | :EXISTS
-        | :GT
-        | :GTE
-        | :INCLUDES
-        | :IS_AFTER
-        | :IS_BEFORE
-        | :LT
-        | :LTE
-        | :NEQ
-        | :OMIT
-        | :STARTS_WITH
-        | :AND
-        | :OR
-
-      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
-
-        def self?.values: -> ::Array[Trycourier::Models::Filter::operator]
-      end
+      def self?.variants: -> ::Array[Trycourier::Models::filter]
     end
   end
 end

data/sig/trycourier/models/filter_config.rbs

@@ -1,69 +1,12 @@
 module Trycourier
   module Models
     type filter_config =
-      {
-        operator: Trycourier::Models::FilterConfig::operator,
-        path: String,
-        value: String
-      }
+      Trycourier::SingleFilterConfig | Trycourier::NestedFilterConfig
 
-    class FilterConfig < Trycourier::Internal::Type::BaseModel
-      attr_accessor operator: Trycourier::Models::FilterConfig::operator
+    module FilterConfig
+      extend Trycourier::Internal::Type::Union
 
-      attr_accessor path: String
-
-      attr_accessor value: String
-
-      def initialize: (
-        operator: Trycourier::Models::FilterConfig::operator,
-        path: String,
-        value: String
-      ) -> void
-
-      def to_hash: -> {
-        operator: Trycourier::Models::FilterConfig::operator,
-        path: String,
-        value: String
-      }
-
-      type operator =
-        :ENDS_WITH
-        | :EQ
-        | :EXISTS
-        | :GT
-        | :GTE
-        | :INCLUDES
-        | :IS_AFTER
-        | :IS_BEFORE
-        | :LT
-        | :LTE
-        | :NEQ
-        | :OMIT
-        | :STARTS_WITH
-        | :AND
-        | :OR
-
-      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
-
-        def self?.values: -> ::Array[Trycourier::Models::FilterConfig::operator]
-      end
+      def self?.variants: -> ::Array[Trycourier::Models::filter_config]
     end
   end
 end