Class: Courier::Models::ProviderUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/provider_update_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(id:, provider:, alias_: nil, settings: nil, title: nil, request_options: {}) ⇒ Object

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

Parameters:

  • id (String)
  • provider (String) —

    The provider key identifying the type.

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

    Updated alias. Omit to clear.

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

    Provider-specific settings (snake_case keys). Replaces the full settings object

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

    Updated display title.

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



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

Instance Attribute Details

#alias_ ⇒ String?

Updated alias. Omit to clear.

Returns:

  • (String, nil) 


25
 
# File 'lib/courier/models/provider_update_params.rb', line 25

optional :alias_, String, api_name: :alias

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/courier/models/provider_update_params.rb', line 13

required :id, String

#provider ⇒ String

The provider key identifying the type.

Returns:

  • (String) 


19
 
# File 'lib/courier/models/provider_update_params.rb', line 19

required :provider, String

#settings ⇒ Hash{Symbol=>Object}?

Provider-specific settings (snake_case keys). Replaces the full settings object — omitted settings fields are removed. Use the catalog endpoint to check required fields.

Returns:

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


33
 
# File 'lib/courier/models/provider_update_params.rb', line 33

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

#title ⇒ String?

Updated display title.

Returns:

  • (String, nil) 


39
 
# File 'lib/courier/models/provider_update_params.rb', line 39

optional :title, String