Class: GrowsurfRuby::Models::Campaign::WebhookCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/growsurf_ruby/models/campaign/webhook_create_params.rb,
sig/growsurf_ruby/models/campaign/webhook_create_params.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Webhooks#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

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(payload_url:, events: nil, is_enabled: nil, secret: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::Campaign::WebhookCreateParams for more details.

Parameters:

  • payload_url (String) —

    The URL that receives webhook deliveries.

  • events (Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>) (defaults to: nil) —

    The events this webhook is subscribed to. When omitted, it is subscribed to no e

  • is_enabled (Boolean) (defaults to: nil)
  • secret (String) (defaults to: nil) —

    Write-only. Used to sign deliveries (the GrowSurf-Signature HMAC header). Never

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



# File 'lib/growsurf_ruby/models/campaign/webhook_create_params.rb', line 36

Instance Attribute Details

#events ⇒ Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>?

The events this webhook is subscribed to. When omitted, it is subscribed to no events.

Returns:



22
 
# File 'lib/growsurf_ruby/models/campaign/webhook_create_params.rb', line 22

optional :events, -> { GrowsurfRuby::Internal::Type::ArrayOf[enum: GrowsurfRuby::Campaign::WebhookEvent] }

#is_enabled ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


27
 
# File 'lib/growsurf_ruby/models/campaign/webhook_create_params.rb', line 27

optional :is_enabled, GrowsurfRuby::Internal::Type::Boolean, api_name: :isEnabled

#payload_url ⇒ String

The URL that receives webhook deliveries.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/growsurf_ruby/models/campaign/webhook_create_params.rb', line 15

required :payload_url, String, api_name: :payloadUrl

#secret ⇒ String?

Write-only. Used to sign deliveries (the GrowSurf-Signature HMAC header). Never returned.

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/growsurf_ruby/models/campaign/webhook_create_params.rb', line 34

optional :secret, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


41
 
# File 'sig/growsurf_ruby/models/campaign/webhook_create_params.rbs', line 41

def to_hash: -> {