Class: Trycourier::Models::WebhookAuthentication

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/webhook_authentication.rb

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(mode:, token: nil, password: nil, username: nil) ⇒ Object

Parameters:

  • mode (Symbol, Trycourier::Models::WebhookAuthMode) —

    The authentication mode to use. Defaults to ‘none’ if not specified.

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

    Token for bearer authentication.

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

    Password for basic authentication.

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

    Username for basic authentication.




# File 'lib/trycourier/models/webhook_authentication.rb', line 30

Instance Attribute Details

#mode ⇒ Symbol, Trycourier::Models::WebhookAuthMode

The authentication mode to use. Defaults to ‘none’ if not specified.

Returns:



10
 
# File 'lib/trycourier/models/webhook_authentication.rb', line 10

required :mode, enum: -> { Trycourier::WebhookAuthMode }

#password ⇒ String?

Password for basic authentication.

Returns:

  • (String, nil) 


22
 
# File 'lib/trycourier/models/webhook_authentication.rb', line 22

optional :password, String, nil?: true

#token ⇒ String?

Token for bearer authentication.

Returns:

  • (String, nil) 


16
 
# File 'lib/trycourier/models/webhook_authentication.rb', line 16

optional :token, String, nil?: true

#username ⇒ String?

Username for basic authentication.

Returns:

  • (String, nil) 


28
 
# File 'lib/trycourier/models/webhook_authentication.rb', line 28

optional :username, String, nil?: true