trycourier 4.7.1 → 4.9.0

data/lib/courier/models/routing_strategy_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#list
+    class RoutingStrategyListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute limit
+      #   Maximum number of results per page. Default 20, max 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @param limit [Integer] Maximum number of results per page. Default 20, max 100.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#list
+    class RoutingStrategyListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::RoutingStrategySummary>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::RoutingStrategySummary] }
+
+      # @!method initialize(paging:, results:)
+      #   Paginated list of routing strategy summaries.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::RoutingStrategySummary>]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_mutation_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#create
+    class RoutingStrategyMutationResponse < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The routing strategy ID (rs\_ prefix).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   Response returned by create and replace operations.
+      #
+      #   @param id [String] The routing strategy ID (rs\_ prefix).
+    end
+  end
+end

data/lib/courier/models/routing_strategy_replace_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::RoutingStrategies#replace
+    class RoutingStrategyReplaceParams < Courier::Models::RoutingStrategyReplaceRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/routing_strategy_replace_request.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class RoutingStrategyReplaceRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   Human-readable name for the routing strategy.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute routing
+      #   Routing tree defining channel selection method and order.
+      #
+      #   @return [Courier::Models::MessageRouting]
+      required :routing, -> { Courier::MessageRouting }
+
+      # @!attribute channels
+      #   Per-channel delivery configuration. Omit to clear.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+      optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }, nil?: true
+
+      # @!attribute description
+      #   Optional description. Omit or null to clear.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute providers
+      #   Per-provider delivery configuration. Omit to clear.
+      #
+      #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+      optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }, nil?: true
+
+      # @!attribute tags
+      #   Optional tags. Omit or null to clear.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!method initialize(name:, routing:, channels: nil, description: nil, providers: nil, tags: nil)
+      #   Request body for replacing a routing strategy. Full document replacement;
+      #   missing optional fields are cleared.
+      #
+      #   @param name [String] Human-readable name for the routing strategy.
+      #
+      #   @param routing [Courier::Models::MessageRouting] Routing tree defining channel selection method and order.
+      #
+      #   @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Per-channel delivery configuration. Omit to clear.
+      #
+      #   @param description [String, nil] Optional description. Omit or null to clear.
+      #
+      #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil] Per-provider delivery configuration. Omit to clear.
+      #
+      #   @param tags [Array<String>, nil] Optional tags. Omit or null to clear.
+    end
+  end
+end

data/lib/courier/models/routing_strategy_retrieve_params.rb

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

data/lib/courier/models/routing_strategy_summary.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class RoutingStrategySummary < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The routing strategy ID (rs\_ prefix).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created
+      #   Epoch milliseconds when the strategy was created.
+      #
+      #   @return [Integer]
+      required :created, Integer
+
+      # @!attribute creator
+      #   User ID of the creator.
+      #
+      #   @return [String]
+      required :creator, String
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #   Description of the routing strategy.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute tags
+      #   Tags for categorization.
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute updated
+      #   Epoch milliseconds of last update.
+      #
+      #   @return [Integer, nil]
+      optional :updated, Integer, nil?: true
+
+      # @!attribute updater
+      #   User ID of the last updater.
+      #
+      #   @return [String, nil]
+      optional :updater, String, nil?: true
+
+      # @!method initialize(id:, created:, creator:, name:, description: nil, tags: nil, updated: nil, updater: nil)
+      #   Routing strategy metadata returned in list responses. Does not include
+      #   routing/channels/providers content.
+      #
+      #   @param id [String] The routing strategy ID (rs\_ prefix).
+      #
+      #   @param created [Integer] Epoch milliseconds when the strategy was created.
+      #
+      #   @param creator [String] User ID of the creator.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param description [String, nil] Description of the routing strategy.
+      #
+      #   @param tags [Array<String>, nil] Tags for categorization.
+      #
+      #   @param updated [Integer, nil] Epoch milliseconds of last update.
+      #
+      #   @param updater [String, nil] User ID of the last updater.
+    end
+  end
+end

data/lib/courier/models/send_message_params.rb

@@ -32,10 +32,8 @@ module Courier
         #   Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
         #   inbox, direct_message, banner, webhook.
         #
-        #   @return [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Channel}, nil]
-        optional :channels,
-                 -> { Courier::Internal::Type::HashOf[Courier::SendMessageParams::Message::Channel] },
-                 nil?: true
+        #   @return [Hash{Symbol=>Courier::Models::Channel}, nil]
+        optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }, nil?: true
 
         # @!attribute content
         #   Describes content that will work for email, inbox, push, chat, or any channel
@@ -76,10 +74,8 @@ module Courier
 
         # @!attribute providers
         #
-        #   @return [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Provider}, nil]
-        optional :providers,
-                 -> { Courier::Internal::Type::HashOf[Courier::SendMessageParams::Message::Provider] },
-                 nil?: true
+        #   @return [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
+        optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }, nil?: true
 
         # @!attribute routing
         #   Customize which channels/providers Courier may deliver the message through.
@@ -112,7 +108,7 @@ module Courier
         #
         #   @param brand_id [String, nil]
         #
-        #   @param channels [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Channel}, nil] Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
+        #   @param channels [Hash{Symbol=>Courier::Models::Channel}, nil] Define run-time configuration for channels. Valid ChannelId's: email, sms, push,
         #
         #   @param content [Courier::Models::ElementalContentSugar, Courier::Models::ElementalContent] Describes content that will work for email, inbox, push, chat, or any channel id
         #
@@ -128,7 +124,7 @@ module Courier
         #
         #   @param preferences [Courier::Models::SendMessageParams::Message::Preferences, nil]
         #
-        #   @param providers [Hash{Symbol=>Courier::Models::SendMessageParams::Message::Provider}, nil]
+        #   @param providers [Hash{Symbol=>Courier::Models::MessageProvidersType}, nil]
         #
         #   @param routing [Courier::Models::SendMessageParams::Message::Routing, nil] Customize which channels/providers Courier may deliver the message through.
         #
@@ -138,106 +134,6 @@ module Courier
         #
         #   @param to [Courier::Models::UserRecipient, Courier::Models::AudienceRecipient, Courier::Models::ListRecipient, Courier::Models::ListPatternRecipient, Courier::Models::SlackRecipient, Courier::Models::MsTeamsRecipient, Courier::Models::PagerdutyRecipient, Courier::Models::WebhookRecipient, Array<Courier::Models::UserRecipient, Courier::Models::AudienceRecipient, Courier::Models::ListRecipient, Courier::Models::ListPatternRecipient, Courier::Models::SlackRecipient, Courier::Models::MsTeamsRecipient, Courier::Models::PagerdutyRecipient, Courier::Models::WebhookRecipient>, nil] The recipient or a list of recipients of the message
 
-        class Channel < Courier::Internal::Type::BaseModel
-          # @!attribute brand_id
-          #   Brand id used for rendering.
-          #
-          #   @return [String, nil]
-          optional :brand_id, String, nil?: true
-
-          # @!attribute if_
-          #   JS conditional with access to data/profile.
-          #
-          #   @return [String, nil]
-          optional :if_, String, api_name: :if, nil?: true
-
-          # @!attribute metadata
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Channel::Metadata, nil]
-          optional :metadata, -> { Courier::SendMessageParams::Message::Channel::Metadata }, nil?: true
-
-          # @!attribute override
-          #   Channel specific overrides.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-          # @!attribute providers
-          #   Providers enabled for this channel.
-          #
-          #   @return [Array<String>, nil]
-          optional :providers, Courier::Internal::Type::ArrayOf[String], nil?: true
-
-          # @!attribute routing_method
-          #   Defaults to `single`.
-          #
-          #   @return [Symbol, Courier::Models::SendMessageParams::Message::Channel::RoutingMethod, nil]
-          optional :routing_method,
-                   enum: -> { Courier::SendMessageParams::Message::Channel::RoutingMethod },
-                   nil?: true
-
-          # @!attribute timeouts
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Channel::Timeouts, nil]
-          optional :timeouts, -> { Courier::SendMessageParams::Message::Channel::Timeouts }, nil?: true
-
-          # @!method initialize(brand_id: nil, if_: nil, metadata: nil, override: nil, providers: nil, routing_method: nil, timeouts: nil)
-          #   @param brand_id [String, nil] Brand id used for rendering.
-          #
-          #   @param if_ [String, nil] JS conditional with access to data/profile.
-          #
-          #   @param metadata [Courier::Models::SendMessageParams::Message::Channel::Metadata, nil]
-          #
-          #   @param override [Hash{Symbol=>Object}, nil] Channel specific overrides.
-          #
-          #   @param providers [Array<String>, nil] Providers enabled for this channel.
-          #
-          #   @param routing_method [Symbol, Courier::Models::SendMessageParams::Message::Channel::RoutingMethod, nil] Defaults to `single`.
-          #
-          #   @param timeouts [Courier::Models::SendMessageParams::Message::Channel::Timeouts, nil]
-
-          # @see Courier::Models::SendMessageParams::Message::Channel#metadata
-          class Metadata < Courier::Internal::Type::BaseModel
-            # @!attribute utm
-            #
-            #   @return [Courier::Models::Utm, nil]
-            optional :utm, -> { Courier::Utm }, nil?: true
-
-            # @!method initialize(utm: nil)
-            #   @param utm [Courier::Models::Utm, nil]
-          end
-
-          # Defaults to `single`.
-          #
-          # @see Courier::Models::SendMessageParams::Message::Channel#routing_method
-          module RoutingMethod
-            extend Courier::Internal::Type::Enum
-
-            ALL = :all
-            SINGLE = :single
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # @see Courier::Models::SendMessageParams::Message::Channel#timeouts
-          class Timeouts < Courier::Internal::Type::BaseModel
-            # @!attribute channel
-            #
-            #   @return [Integer, nil]
-            optional :channel, Integer, nil?: true
-
-            # @!attribute provider
-            #
-            #   @return [Integer, nil]
-            optional :provider, Integer, nil?: true
-
-            # @!method initialize(channel: nil, provider: nil)
-            #   @param channel [Integer, nil]
-            #   @param provider [Integer, nil]
-          end
-        end
-
         # Describes content that will work for email, inbox, push, chat, or any channel
         # id.
         #
@@ -362,50 +258,6 @@ module Courier
           #   @param subscription_topic_id [String] The subscription topic to apply to the message.
         end
 
-        class Provider < Courier::Internal::Type::BaseModel
-          # @!attribute if_
-          #   JS conditional with access to data/profile.
-          #
-          #   @return [String, nil]
-          optional :if_, String, api_name: :if, nil?: true
-
-          # @!attribute metadata
-          #
-          #   @return [Courier::Models::SendMessageParams::Message::Provider::Metadata, nil]
-          optional :metadata, -> { Courier::SendMessageParams::Message::Provider::Metadata }, nil?: true
-
-          # @!attribute override
-          #   Provider-specific overrides.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :override, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
-
-          # @!attribute timeouts
-          #
-          #   @return [Integer, nil]
-          optional :timeouts, Integer, nil?: true
-
-          # @!method initialize(if_: nil, metadata: nil, override: nil, timeouts: nil)
-          #   @param if_ [String, nil] JS conditional with access to data/profile.
-          #
-          #   @param metadata [Courier::Models::SendMessageParams::Message::Provider::Metadata, nil]
-          #
-          #   @param override [Hash{Symbol=>Object}, nil] Provider-specific overrides.
-          #
-          #   @param timeouts [Integer, nil]
-
-          # @see Courier::Models::SendMessageParams::Message::Provider#metadata
-          class Metadata < Courier::Internal::Type::BaseModel
-            # @!attribute utm
-            #
-            #   @return [Courier::Models::Utm, nil]
-            optional :utm, -> { Courier::Utm }, nil?: true
-
-            # @!method initialize(utm: nil)
-            #   @param utm [Courier::Models::Utm, nil]
-          end
-        end
-
         # @see Courier::Models::SendMessageParams::Message#routing
         class Routing < Courier::Internal::Type::BaseModel
           # @!attribute channels

data/lib/courier/models/tenant_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(tenant_id:, request_options: {})
+      #   @param tenant_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/tenant_list_users_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
       # @!attribute cursor
       #   Continue the pagination with the next cursor
       #
@@ -19,10 +24,12 @@ module Courier
       #   @return [Integer, nil]
       optional :limit, Integer, nil?: true
 
-      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::TenantListUsersParams} for more details.
       #
+      #   @param tenant_id [String]
+      #
       #   @param cursor [String, nil] Continue the pagination with the next cursor
       #
       #   @param limit [Integer, nil] The number of accounts to return

data/lib/courier/models/tenant_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(tenant_id:, request_options: {})
+      #   @param tenant_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end