Class: GrowsurfRuby::Models::Campaign::WebhookUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• GrowsurfRuby::Resources::Campaign::Webhooks#update

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::GrowsurfRuby

Instance Attribute Summary

• #events ⇒ Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>^?
• #id ⇒ String
• #is_enabled ⇒ Boolean^?
• #payload_url ⇒ String^?
• #secret ⇒ String^?

  Write-only.

• #webhook_id ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, webhook_id:, events: nil, is_enabled: nil, payload_url: nil, secret: nil, request_options: {}) ⇒ Object constructor
• #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:, events: nil, is_enabled: nil, payload_url: nil, secret: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• webhook_id (String)
• events (Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>) (defaults to: nil)
• is_enabled (Boolean) (defaults to: nil)
• payload_url (String) (defaults to: nil)
• secret (String) (defaults to: nil) —

  Write-only.

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

# File 'lib/growsurf_ruby/models/campaign/webhook_update_params.rb', line 42

Instance Attribute Details

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

Returns:

• (Array<Symbol, GrowsurfRuby::Models::Campaign::WebhookEvent>, nil)

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

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#is_enabled ⇒ Boolean^?

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/growsurf_ruby/models/campaign/webhook_update_params.rb', line 29

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

#payload_url ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :payload_url, String, api_name: :payloadUrl

#secret ⇒ String^?

Write-only.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/growsurf_ruby/models/campaign/webhook_update_params.rb', line 40

optional :secret, String

#webhook_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :webhook_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/growsurf_ruby/models/campaign/webhook_update_params.rbs', line 51

def to_hash: -> {