Class: Cerca::Models::WebhookUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/cerca/models/webhook_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(fleet_id:, webhook_id:, enabled: nil, events: nil, url: nil, request_options: {}) ⇒ Object

Parameters:

  • fleet_id (String)
  • webhook_id (String)
  • enabled (Boolean) (defaults to: nil) —

    Whether deliveries are enabled for this subscription.

  • events (Array<Symbol, Cerca::Models::WebhookSubscriptionEventType>) (defaults to: nil) —

    Event names to deliver. Omit to subscribe to all non-test events.

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

    HTTPS endpoint that will receive webhook deliveries.

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



# File 'lib/cerca/models/webhook_update_params.rb', line 38

Instance Attribute Details

#enabled ⇒ Boolean?

Whether deliveries are enabled for this subscription.

Returns:

  • (Boolean, nil) 


24
 
# File 'lib/cerca/models/webhook_update_params.rb', line 24

optional :enabled, Cerca::Internal::Type::Boolean

#events ⇒ Array<Symbol, Cerca::Models::WebhookSubscriptionEventType>?

Event names to deliver. Omit to subscribe to all non-test events.

Returns:



30
 
# File 'lib/cerca/models/webhook_update_params.rb', line 30

optional :events, -> { Cerca::Internal::Type::ArrayOf[enum: Cerca::WebhookSubscriptionEventType] }

#fleet_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/cerca/models/webhook_update_params.rb', line 13

required :fleet_id, String

#url ⇒ String?

HTTPS endpoint that will receive webhook deliveries.

Returns:

  • (String, nil) 


36
 
# File 'lib/cerca/models/webhook_update_params.rb', line 36

optional :url, String

#webhook_id ⇒ String

Returns:

  • (String) 


18
 
# File 'lib/cerca/models/webhook_update_params.rb', line 18

required :webhook_id, String