Class: Courier::Models::RoutingStrategyGetResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Courier::Models::RoutingStrategyGetResponse

Defined in:

lib/courier/models/routing_strategy_get_response.rb

Overview

See Also:

• Resources::RoutingStrategies#retrieve

Instance Attribute Summary

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

  Per-channel delivery configuration.

• #created ⇒ Integer

  Epoch milliseconds when the strategy was created.

• #creator ⇒ String

  User ID of the creator.

• #description ⇒ String^?

  Description of the routing strategy.

• #id ⇒ String

  The routing strategy ID (rs_ prefix).

• #name ⇒ String

  Human-readable name.

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

  Per-provider delivery configuration.

• #routing ⇒ Courier::Models::MessageRouting

  Routing tree defining channel selection method and order.

• #tags ⇒ Array<String>^?

  Tags for categorization.

• #updated ⇒ Integer^?

  Epoch milliseconds of last update.

• #updater ⇒ String^?

  User ID of the last updater.

Instance Method Summary

• #initialize(id:, channels:, created:, creator:, name:, providers:, routing:, description: nil, tags: nil, updated: nil, updater: nil) ⇒ Object constructor

  Full routing strategy entity returned by GET.

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(id:, channels:, created:, creator:, name:, providers:, routing:, description: nil, tags: nil, updated: nil, updater: nil) ⇒ Object

Full routing strategy entity returned by GET.

Parameters:

• id (String) —

  The routing strategy ID (rs_ prefix).

• channels (Hash{Symbol=>Courier::Models::Channel}) —

  Per-channel delivery configuration. May be empty.

• created (Integer) —

  Epoch milliseconds when the strategy was created.

• creator (String) —

  User ID of the creator.

• name (String) —

  Human-readable name.

• providers (Hash{Symbol=>Courier::Models::MessageProvidersType}) —

  Per-provider delivery configuration. May be empty.

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

  Routing tree defining channel selection method and order.

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

  Description of the routing strategy.

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

  Tags for categorization.

• updated (Integer, nil) (defaults to: nil) —

  Epoch milliseconds of last update.

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

  User ID of the last updater.

# File 'lib/courier/models/routing_strategy_get_response.rb', line 73

Instance Attribute Details

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

Per-channel delivery configuration. May be empty.

Returns:

• (Hash{Symbol=>Courier::Models::Channel})

# File 'lib/courier/models/routing_strategy_get_response.rb', line 17

required :channels, -> { Courier::Internal::Type::HashOf[Courier::Channel] }

#created ⇒ Integer

Epoch milliseconds when the strategy was created.

Returns:

• (Integer)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 23

required :created, Integer

#creator ⇒ String

User ID of the creator.

Returns:

• (String)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 29

required :creator, String

#description ⇒ String^?

Description of the routing strategy.

Returns:

• (String, nil)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 53

optional :description, String, nil?: true

#id ⇒ String

The routing strategy ID (rs_ prefix).

Returns:

• (String)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 11

required :id, String

#name ⇒ String

Human-readable name.

Returns:

• (String)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 35

required :name, String

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

Per-provider delivery configuration. May be empty.

Returns:

• (Hash{Symbol=>Courier::Models::MessageProvidersType})

# File 'lib/courier/models/routing_strategy_get_response.rb', line 41

required :providers, -> { Courier::Internal::Type::HashOf[Courier::MessageProvidersType] }

#routing ⇒ Courier::Models::MessageRouting

Routing tree defining channel selection method and order.

Returns:

• (Courier::Models::MessageRouting)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 47

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

#tags ⇒ Array<String>^?

Tags for categorization.

Returns:

• (Array<String>, nil)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 59

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

#updated ⇒ Integer^?

Epoch milliseconds of last update.

Returns:

• (Integer, nil)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 65

optional :updated, Integer, nil?: true

#updater ⇒ String^?

User ID of the last updater.

Returns:

• (String, nil)

# File 'lib/courier/models/routing_strategy_get_response.rb', line 71

optional :updater, String, nil?: true