Class: Believe::Models::WebhookTriggerEventParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/believe/models/webhook_trigger_event_params.rb

Overview

See Also:

• Resources::Webhooks#trigger_event

Defined Under Namespace

Modules: EventType, Payload

Instance Attribute Summary

• #event_type ⇒ Symbol, ::Believe::Models::WebhookTriggerEventParams::EventType

  The type of event to trigger.

• #payload ⇒ ::Believe::Models::WebhookTriggerEventParams::Payload::MatchCompleted, ...

  Optional event payload.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(event_type:, payload: nil, request_options: {}) ⇒ Object constructor

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(event_type:, payload: nil, request_options: {}) ⇒ Object

Parameters:

• event_type (Symbol, ::Believe::Models::WebhookTriggerEventParams::EventType) —

  The type of event to trigger

• payload (::Believe::Models::WebhookTriggerEventParams::Payload::MatchCompleted, ::Believe::Models::WebhookTriggerEventParams::Payload::TeamMemberTransferred, nil) (defaults to: nil) —

  Optional event payload. If not provided, a sample payload will be generated.

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

# File 'lib/believe/models/webhook_trigger_event_params.rb', line 22

Instance Attribute Details

#event_type ⇒ Symbol, ::Believe::Models::WebhookTriggerEventParams::EventType

The type of event to trigger

Returns:

• (Symbol, ::Believe::Models::WebhookTriggerEventParams::EventType)

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

required :event_type, enum: -> { ::Believe::WebhookTriggerEventParams::EventType }

#payload ⇒ ::Believe::Models::WebhookTriggerEventParams::Payload::MatchCompleted, ...

Optional event payload. If not provided, a sample payload will be generated.

Returns:

• (::Believe::Models::WebhookTriggerEventParams::Payload::MatchCompleted, ::Believe::Models::WebhookTriggerEventParams::Payload::TeamMemberTransferred, nil)

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

optional :payload, union: -> { ::Believe::WebhookTriggerEventParams::Payload }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/believe/models/webhook_trigger_event_params.rb', line 36