Class: Believe::Models::WebhookCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Believe::Models::WebhookCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/believe/models/webhook_create_params.rb

Overview

See Also:

• Resources::Webhooks#create

Defined Under Namespace

Modules: EventType

Instance Attribute Summary

• #description ⇒ String^?

  Optional description for this webhook.

• #event_types ⇒ Array<Symbol, ::Believe::Models::WebhookCreateParams::EventType>^?

  List of event types to subscribe to.

• #url ⇒ String

  The URL to send webhook events to.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Believe::Internal::Type::BaseModel

Instance Attribute Details

#description ⇒ String^?

Optional description for this webhook

Returns:

• (String, nil)

# File 'lib/believe/models/webhook_create_params.rb', line 20

optional :description, String, nil?: true

#event_types ⇒ Array<Symbol, ::Believe::Models::WebhookCreateParams::EventType>^?

List of event types to subscribe to. If not provided, subscribes to all events.

Returns:

• (Array<Symbol, ::Believe::Models::WebhookCreateParams::EventType>, nil)

# File 'lib/believe/models/webhook_create_params.rb', line 26

optional :event_types,
-> { ::Believe::Internal::Type::ArrayOf[enum: ::Believe::WebhookCreateParams::EventType] },
nil?: true

#url ⇒ String

The URL to send webhook events to

Returns:

• (String)

# File 'lib/believe/models/webhook_create_params.rb', line 14

required :url, String