Class: Courier::Models::RoutingStrategyCreateRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/routing_strategy_create_request.rb

Direct Known Subclasses

RoutingStrategyCreateParams

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, routing:, channels: nil, description: nil, providers: nil, tags: nil) ⇒ Object

Request body for creating a routing strategy.

Parameters:

  • name (String) —

    Human-readable name for the routing strategy.

  • routing (Courier::Models::MessageRouting) —

    Routing tree defining channel selection method and order.

  • channels (Hash{Symbol=>Courier::Models::Channel}, nil) (defaults to: nil) —

    Per-channel delivery configuration. Defaults to empty if omitted.

  • description (String, nil) (defaults to: nil) —

    Optional description of the routing strategy.

  • providers (Hash{Symbol=>Courier::Models::MessageProvidersType}, nil) (defaults to: nil) —

    Per-provider delivery configuration. Defaults to empty if omitted.

  • tags (Array<String>, nil) (defaults to: nil) —

    Optional tags for categorization.




# File 'lib/courier/models/routing_strategy_create_request.rb', line 42

Instance Attribute Details

#channels ⇒ Hash{Symbol=>Courier::Models::Channel}?

Per-channel delivery configuration. Defaults to empty if omitted.

Returns:



22
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 22

optional :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }, nil?: true

#description ⇒ String?

Optional description of the routing strategy.

Returns:

  • (String, nil) 


28
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 28

optional :description, String, nil?: true

#name ⇒ String

Human-readable name for the routing strategy.

Returns:

  • (String) 


10
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 10

required :name, String

#providers ⇒ Hash{Symbol=>Courier::Models::MessageProvidersType}?

Per-provider delivery configuration. Defaults to empty if omitted.

Returns:



34
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 34

optional :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }, nil?: true

#routing ⇒ Courier::Models::MessageRouting

Routing tree defining channel selection method and order.

Returns:



16
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 16

required :routing, -> { Courier::MessageRouting }

#tags ⇒ Array<String>?

Optional tags for categorization.

Returns:

  • (Array<String>, nil) 


40
 
# File 'lib/courier/models/routing_strategy_create_request.rb', line 40

optional :tags, Courier::Internal::Type::ArrayOf[String], nil?: true