trycourier 4.7.1 → 4.9.0

data/rbi/courier/resources/routing_strategies.rbi

@@ -0,0 +1,126 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class RoutingStrategies
+      # Create a routing strategy. Requires a name and routing configuration at minimum.
+      # Channels and providers default to empty if omitted.
+      sig do
+        params(
+          name: String,
+          routing: Courier::MessageRouting::OrHash,
+          channels: T.nilable(T::Hash[Symbol, Courier::Channel::OrHash]),
+          description: T.nilable(String),
+          providers:
+            T.nilable(T::Hash[Symbol, Courier::MessageProvidersType::OrHash]),
+          tags: T.nilable(T::Array[String]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::RoutingStrategyMutationResponse)
+      end
+      def create(
+        # Human-readable name for the routing strategy.
+        name:,
+        # Routing tree defining channel selection method and order.
+        routing:,
+        # Per-channel delivery configuration. Defaults to empty if omitted.
+        channels: nil,
+        # Optional description of the routing strategy.
+        description: nil,
+        # Per-provider delivery configuration. Defaults to empty if omitted.
+        providers: nil,
+        # Optional tags for categorization.
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a routing strategy by ID. Returns the full entity including routing
+      # content and metadata.
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::RoutingStrategyGetResponse)
+      end
+      def retrieve(
+        # Routing strategy ID (rs\_ prefix).
+        id,
+        request_options: {}
+      )
+      end
+
+      # List routing strategies in your workspace. Returns metadata only (no
+      # routing/channels/providers content). Use GET /routing-strategies/{id} for full
+      # details.
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::RoutingStrategyListResponse)
+      end
+      def list(
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of results per page. Default 20, max 100.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Archive a routing strategy. The strategy must not have associated notification
+      # templates. Unlink all templates before archiving.
+      sig do
+        params(
+          id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def archive(
+        # Routing strategy ID (rs\_ prefix).
+        id,
+        request_options: {}
+      )
+      end
+
+      # Replace a routing strategy. Full document replacement; the caller must send the
+      # complete desired state. Missing optional fields are cleared.
+      sig do
+        params(
+          id: String,
+          name: String,
+          routing: Courier::MessageRouting::OrHash,
+          channels: T.nilable(T::Hash[Symbol, Courier::Channel::OrHash]),
+          description: T.nilable(String),
+          providers:
+            T.nilable(T::Hash[Symbol, Courier::MessageProvidersType::OrHash]),
+          tags: T.nilable(T::Array[String]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::RoutingStrategyMutationResponse)
+      end
+      def replace(
+        # Routing strategy ID (rs\_ prefix).
+        id,
+        # Human-readable name for the routing strategy.
+        name:,
+        # Routing tree defining channel selection method and order.
+        routing:,
+        # Per-channel delivery configuration. Omit to clear.
+        channels: nil,
+        # Optional description. Omit or null to clear.
+        description: nil,
+        # Per-provider delivery configuration. Omit to clear.
+        providers: nil,
+        # Optional tags. Omit or null to clear.
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/courier/resources/users/tokens.rbi

@@ -89,25 +89,27 @@ module Courier
         # Adds a single token to a user and overwrites a matching existing token.
         sig do
           params(
-            path_token: String,
+            token: String,
             user_id: String,
-            body_token: String,
-            provider_key: Courier::Users::UserToken::ProviderKey::OrSymbol,
-            device: T.nilable(Courier::Users::UserToken::Device::OrHash),
+            provider_key:
+              Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol,
+            device:
+              T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash),
             expiry_date:
-              T.nilable(Courier::Users::UserToken::ExpiryDate::Variants),
+              T.nilable(
+                Courier::Users::TokenAddSingleParams::ExpiryDate::Variants
+              ),
             properties: T.anything,
-            tracking: T.nilable(Courier::Users::UserToken::Tracking::OrHash),
+            tracking:
+              T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash),
             request_options: Courier::RequestOptions::OrHash
           ).void
         end
         def add_single(
           # Path param: The full token string.
-          path_token,
+          token,
           # Path param: The user's ID. This can be any uniquely identifiable string.
           user_id:,
-          # Body param: Full body of the token. Must match token in URL path parameter.
-          body_token:,
           # Body param
           provider_key:,
           # Body param: Information about the device the token came from.

data/sig/courier/client.rbs

@@ -14,12 +14,16 @@ module Courier
 
     attr_reader audiences: Courier::Resources::Audiences
 
+    attr_reader providers: Courier::Resources::Providers
+
     attr_reader audit_events: Courier::Resources::AuditEvents
 
     attr_reader auth: Courier::Resources::Auth
 
     attr_reader automations: Courier::Resources::Automations
 
+    attr_reader journeys: Courier::Resources::Journeys
+
     attr_reader brands: Courier::Resources::Brands
 
     attr_reader bulk: Courier::Resources::Bulk
@@ -34,6 +38,8 @@ module Courier
 
     attr_reader notifications: Courier::Resources::Notifications
 
+    attr_reader routing_strategies: Courier::Resources::RoutingStrategies
+
     attr_reader profiles: Courier::Resources::Profiles
 
     attr_reader tenants: Courier::Resources::Tenants

data/sig/courier/internal/util.rbs

@@ -45,8 +45,12 @@ module Courier
         -> top?
       } -> top?
 
+      RFC_3986_NOT_PCHARS: Regexp
+
       def self?.uri_origin: (URI::Generic uri) -> String
 
+      def self?.encode_path: (String | Integer path) -> String
+
       def self?.interpolate_path: (String | ::Array[String] path) -> String
 
       def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
@@ -106,6 +110,16 @@ module Courier
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/courier/models/audience_delete_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type audience_delete_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { audience_id: String } & Courier::Internal::Type::request_parameters
 
     class AudienceDeleteParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor audience_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        audience_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        audience_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/audience_list_members_params.rbs

@@ -1,20 +1,25 @@
 module Courier
   module Models
     type audience_list_members_params =
-      { cursor: String? } & Courier::Internal::Type::request_parameters
+      { audience_id: String, cursor: String? }
+      & Courier::Internal::Type::request_parameters
 
     class AudienceListMembersParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor audience_id: String
+
       attr_accessor cursor: String?
 
       def initialize: (
+        audience_id: String,
         ?cursor: String?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
+        audience_id: String,
         cursor: String?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/audience_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type audience_retrieve_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { audience_id: String } & Courier::Internal::Type::request_parameters
 
     class AudienceRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor audience_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        audience_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        audience_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/audience_update_params.rbs

@@ -2,6 +2,7 @@ module Courier
   module Models
     type audience_update_params =
       {
+        audience_id: String,
         description: String?,
         filter: Courier::AudienceFilterConfig?,
         name: String?,
@@ -13,6 +14,8 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor audience_id: String
+
       attr_accessor description: String?
 
       attr_accessor filter: Courier::AudienceFilterConfig?
@@ -22,6 +25,7 @@ module Courier
       attr_accessor operator: Courier::Models::AudienceUpdateParams::operator?
 
       def initialize: (
+        audience_id: String,
         ?description: String?,
         ?filter: Courier::AudienceFilterConfig?,
         ?name: String?,
@@ -30,6 +34,7 @@ module Courier
       ) -> void
 
       def to_hash: -> {
+        audience_id: String,
         description: String?,
         filter: Courier::AudienceFilterConfig?,
         name: String?,

data/sig/courier/models/audit_event_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type audit_event_retrieve_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { audit_event_id: String } & Courier::Internal::Type::request_parameters
 
     class AuditEventRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor audit_event_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        audit_event_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        audit_event_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/automations/invoke_invoke_by_template_params.rbs

@@ -3,6 +3,7 @@ module Courier
     module Automations
       type invoke_invoke_by_template_params =
         {
+          template_id: String,
           recipient: String?,
           brand: String?,
           data: ::Hash[Symbol, top]?,
@@ -15,6 +16,8 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        attr_accessor template_id: String
+
         attr_accessor recipient: String?
 
         attr_accessor brand: String?
@@ -26,6 +29,7 @@ module Courier
         attr_accessor template: String?
 
         def initialize: (
+          template_id: String,
           recipient: String?,
           ?brand: String?,
           ?data: ::Hash[Symbol, top]?,
@@ -35,6 +39,7 @@ module Courier
         ) -> void
 
         def to_hash: -> {
+          template_id: String,
           recipient: String?,
           brand: String?,
           data: ::Hash[Symbol, top]?,

data/sig/courier/models/brand_delete_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type brand_delete_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { brand_id: String } & Courier::Internal::Type::request_parameters
 
     class BrandDeleteParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor brand_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        brand_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        brand_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/brand_retrieve_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type brand_retrieve_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { brand_id: String } & Courier::Internal::Type::request_parameters
 
     class BrandRetrieveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor brand_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        brand_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        brand_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/brand_update_params.rbs

@@ -2,6 +2,7 @@ module Courier
   module Models
     type brand_update_params =
       {
+        brand_id: String,
         name: String,
         settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?
@@ -12,6 +13,8 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor brand_id: String
+
       attr_accessor name: String
 
       attr_accessor settings: Courier::BrandSettings?
@@ -19,6 +22,7 @@ module Courier
       attr_accessor snippets: Courier::BrandSnippets?
 
       def initialize: (
+        brand_id: String,
         name: String,
         ?settings: Courier::BrandSettings?,
         ?snippets: Courier::BrandSnippets?,
@@ -26,6 +30,7 @@ module Courier
       ) -> void
 
       def to_hash: -> {
+        brand_id: String,
         name: String,
         settings: Courier::BrandSettings?,
         snippets: Courier::BrandSnippets?,

data/sig/courier/models/bulk_add_users_params.rbs

@@ -1,21 +1,25 @@
 module Courier
   module Models
     type bulk_add_users_params =
-      { users: ::Array[Courier::InboundBulkMessageUser] }
+      { job_id: String, users: ::Array[Courier::InboundBulkMessageUser] }
       & Courier::Internal::Type::request_parameters
 
     class BulkAddUsersParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor job_id: String
+
       attr_accessor users: ::Array[Courier::InboundBulkMessageUser]
 
       def initialize: (
+        job_id: String,
         users: ::Array[Courier::InboundBulkMessageUser],
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
+        job_id: String,
         users: ::Array[Courier::InboundBulkMessageUser],
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/bulk_list_users_params.rbs

@@ -1,20 +1,25 @@
 module Courier
   module Models
     type bulk_list_users_params =
-      { cursor: String? } & Courier::Internal::Type::request_parameters
+      { job_id: String, cursor: String? }
+      & Courier::Internal::Type::request_parameters
 
     class BulkListUsersParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      attr_accessor job_id: String
+
       attr_accessor cursor: String?
 
       def initialize: (
+        job_id: String,
         ?cursor: String?,
         ?request_options: Courier::request_opts
       ) -> void
 
       def to_hash: -> {
+        job_id: String,
         cursor: String?,
         request_options: Courier::RequestOptions
       }

data/sig/courier/models/bulk_retrieve_job_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type bulk_retrieve_job_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { job_id: String } & Courier::Internal::Type::request_parameters
 
     class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor job_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        job_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/bulk_run_job_params.rbs

@@ -1,15 +1,23 @@
 module Courier
   module Models
     type bulk_run_job_params =
-      {  } & Courier::Internal::Type::request_parameters
+      { job_id: String } & Courier::Internal::Type::request_parameters
 
     class BulkRunJobParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Courier::request_opts) -> void
+      attr_accessor job_id: String
 
-      def to_hash: -> { request_options: Courier::RequestOptions }
+      def initialize: (
+        job_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        request_options: Courier::RequestOptions
+      }
     end
   end
 end

data/sig/courier/models/channel.rbs

@@ -0,0 +1,61 @@
+module Courier
+  module Models
+    type channel =
+      {
+        brand_id: String?,
+        if_: String?,
+        metadata: Courier::ChannelMetadata?,
+        override: ::Hash[Symbol, top]?,
+        providers: ::Array[String]?,
+        routing_method: Courier::Models::Channel::routing_method?,
+        timeouts: Courier::Timeouts?
+      }
+
+    class Channel < Courier::Internal::Type::BaseModel
+      attr_accessor brand_id: String?
+
+      attr_accessor if_: String?
+
+      attr_accessor metadata: Courier::ChannelMetadata?
+
+      attr_accessor override: ::Hash[Symbol, top]?
+
+      attr_accessor providers: ::Array[String]?
+
+      attr_accessor routing_method: Courier::Models::Channel::routing_method?
+
+      attr_accessor timeouts: Courier::Timeouts?
+
+      def initialize: (
+        ?brand_id: String?,
+        ?if_: String?,
+        ?metadata: Courier::ChannelMetadata?,
+        ?override: ::Hash[Symbol, top]?,
+        ?providers: ::Array[String]?,
+        ?routing_method: Courier::Models::Channel::routing_method?,
+        ?timeouts: Courier::Timeouts?
+      ) -> void
+
+      def to_hash: -> {
+        brand_id: String?,
+        if_: String?,
+        metadata: Courier::ChannelMetadata?,
+        override: ::Hash[Symbol, top]?,
+        providers: ::Array[String]?,
+        routing_method: Courier::Models::Channel::routing_method?,
+        timeouts: Courier::Timeouts?
+      }
+
+      type routing_method = :all | :single
+
+      module RoutingMethod
+        extend Courier::Internal::Type::Enum
+
+        ALL: :all
+        SINGLE: :single
+
+        def self?.values: -> ::Array[Courier::Models::Channel::routing_method]
+      end
+    end
+  end
+end

data/sig/courier/models/channel_metadata.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type channel_metadata = { utm: Courier::Utm? }
+
+    class ChannelMetadata < Courier::Internal::Type::BaseModel
+      attr_accessor utm: Courier::Utm?
+
+      def initialize: (?utm: Courier::Utm?) -> void
+
+      def to_hash: -> { utm: Courier::Utm? }
+    end
+  end
+end