Class: Courier::Models::ProviderCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/provider_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(provider:, alias_: nil, settings: nil, title: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::ProviderCreateParams for more details.

Parameters:

  • provider (String) —

    The provider key identifying the type (e.g. “sendgrid”, “twilio”). Must be a kno

  • alias_ (String) (defaults to: nil) —

    Optional alias for this configuration.

  • settings (Hash{Symbol=>Object}) (defaults to: nil) —

    Provider-specific settings (snake_case keys). Defaults to an empty object when o

  • title (String) (defaults to: nil) —

    Optional display title. Omit to use “Default Configuration”.

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



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

Instance Attribute Details

#alias_ ⇒ String?

Optional alias for this configuration.

Returns:

  • (String, nil) 


21
 
# File 'lib/courier/models/provider_create_params.rb', line 21

optional :alias_, String, api_name: :alias

#provider ⇒ String

The provider key identifying the type (e.g. “sendgrid”, “twilio”). Must be a known Courier provider — see the catalog endpoint for valid keys.

Returns:

  • (String) 


15
 
# File 'lib/courier/models/provider_create_params.rb', line 15

required :provider, String

#settings ⇒ Hash{Symbol=>Object}?

Provider-specific settings (snake_case keys). Defaults to an empty object when omitted. Use the catalog endpoint to discover required fields for a given provider — omitting a required field returns a 400 validation error.

Returns:

  • (Hash{Symbol=>Object}, nil) 


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

optional :settings, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]

#title ⇒ String?

Optional display title. Omit to use “Default Configuration”.

Returns:

  • (String, nil) 


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

optional :title, String