Class: Courier::Models::ProvidersCatalogEntry

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

Defined Under Namespace

Classes: Setting

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Courier::Internal::Type::BaseModel

Instance Attribute Details

#channel ⇒ String

Courier taxonomy channel (e.g. email, push, sms, direct_message, inbox, webhook).

Returns:

  • (String) 


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

required :channel, String

#description ⇒ String

Short description of the provider.

Returns:

  • (String) 


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

required :description, String

#name ⇒ String

Human-readable display name.

Returns:

  • (String) 


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

required :name, String

#provider ⇒ String

The provider key (e.g. “sendgrid”, “twilio”).

Returns:

  • (String) 


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

required :provider, String

#settings ⇒ Hash{Symbol=>Courier::Models::ProvidersCatalogEntry::Setting}

Map of setting field names (snake_case) to their schema descriptors. Each descriptor has ‘type` and `required`. Empty when the provider has no configurable schema.

Returns:



37
 
# File 'lib/courier/models/providers_catalog_entry.rb', line 37

required :settings, -> { Courier::Internal::Type::HashOf[Courier::ProvidersCatalogEntry::Setting] }