Class: GrowsurfRuby::Models::Campaign::WebhookTestParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• GrowsurfRuby::Models::Campaign::WebhookTestParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/growsurf_ruby/models/campaign/webhook_test_params.rb,
sig/growsurf_ruby/models/campaign/webhook_test_params.rbs

Overview

See Also:

• GrowsurfRuby::Resources::Campaign::Webhooks#test

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary

• #event ⇒ Symbol, ...

  The event to simulate.

• #id ⇒ String
• #webhook_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, webhook_id:, event: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebhookTestParams for more details.

• #to_hash ⇒ {

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:, webhook_id:, event: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• webhook_id (String)
• event (Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent) (defaults to: nil) —

  The event to simulate. When omitted, the webhook's first enabled event is used (

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

# File 'lib/growsurf_ruby/models/campaign/webhook_test_params.rb', line 28

Instance Attribute Details

#event ⇒ Symbol, ...

The event to simulate. When omitted, the webhook's first enabled event is used (returns 400 if it has no enabled events).

Returns:

• (Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent, nil)

# File 'lib/growsurf_ruby/models/campaign/webhook_test_params.rb', line 26

optional :event, enum: -> { GrowsurfRuby::Campaign::WebhookEvent }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/growsurf_ruby/models/campaign/webhook_test_params.rb', line 14

required :id, String

#webhook_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/growsurf_ruby/models/campaign/webhook_test_params.rb', line 19

required :webhook_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/campaign/webhook_test_params.rbs', line 33

def to_hash: -> {