Class: Trycourier::Models::WebhookProfile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/webhook_profile.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(url:, authentication: nil, headers: nil, method_: nil, profile: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::WebhookProfile for more details.

Parameters:

  • url (String) —

    The URL to send the webhook request to.

  • authentication (Trycourier::Models::WebhookAuthentication, nil) (defaults to: nil) —

    Authentication configuration for the webhook request.

  • headers (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Custom headers to include in the webhook request.

  • method_ (Symbol, Trycourier::Models::WebhookMethod, nil) (defaults to: nil) —

    The HTTP method to use for the webhook request. Defaults to POST if not specifie

  • profile (Symbol, Trycourier::Models::WebhookProfileType, nil) (defaults to: nil) —

    Specifies what profile information is included in the request payload. Defaults




# File 'lib/trycourier/models/webhook_profile.rb', line 38

Instance Attribute Details

#authentication ⇒ Trycourier::Models::WebhookAuthentication?

Authentication configuration for the webhook request.

Returns:



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

optional :authentication, -> { Trycourier::WebhookAuthentication }, nil?: true

#headers ⇒ Hash{Symbol=>String}?

Custom headers to include in the webhook request.

Returns:

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


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

optional :headers, Trycourier::Internal::Type::HashOf[String], nil?: true

#method_ ⇒ Symbol, ...

The HTTP method to use for the webhook request. Defaults to POST if not specified.

Returns:



29
 
# File 'lib/trycourier/models/webhook_profile.rb', line 29

optional :method_, enum: -> { Trycourier::WebhookMethod }, api_name: :method, nil?: true

#profile ⇒ Symbol, ...

Specifies what profile information is included in the request payload. Defaults to ‘limited’ if not specified.

Returns:



36
 
# File 'lib/trycourier/models/webhook_profile.rb', line 36

optional :profile, enum: -> { Trycourier::WebhookProfileType }, nil?: true

#url ⇒ String

The URL to send the webhook request to.

Returns:

  • (String) 


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

required :url, String