Class: Believe::Models::WebhookTriggerEventResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/believe/models/webhook_trigger_event_response.rb

Overview

See Also:

Defined Under Namespace

Modules: EventType Classes: Delivery

Instance Attribute Summary collapse

Instance Method Summary collapse

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(success:, url:, webhook_id:, error: nil, status_code: nil) ⇒ Object

Result of delivering a webhook to a single endpoint.

Parameters:

  • success (Boolean) —

    Whether delivery was successful

  • url (String) —

    URL the webhook was sent to

  • webhook_id (String) —

    ID of the webhook

  • error (String, nil) (defaults to: nil) —

    Error message if delivery failed

  • status_code (Integer, nil) (defaults to: nil) —

    HTTP status code from the endpoint




# File 'lib/believe/models/webhook_trigger_event_response.rb', line 90

Instance Attribute Details

#deliveries ⇒ Array<::Believe::Models::WebhookTriggerEventResponse::Delivery>

Results of webhook deliveries

Returns:



11
12
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 11

required :deliveries,
-> { ::Believe::Internal::Type::ArrayOf[::Believe::Models::WebhookTriggerEventResponse::Delivery] }

#event_id ⇒ String

Unique event identifier

Returns:

  • (String) 


18
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 18

required :event_id, String

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

The type of event triggered

Returns:



24
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 24

required :event_type, enum: -> { ::Believe::Models::WebhookTriggerEventResponse::EventType }

#successful_deliveries ⇒ Integer

Number of successful deliveries

Returns:

  • (Integer) 


30
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 30

required :successful_deliveries, Integer

#ted_says ⇒ String

Ted’s reaction

Returns:

  • (String) 


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

required :ted_says, String

#total_webhooks ⇒ Integer

Total number of webhooks that received this event

Returns:

  • (Integer) 


42
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 42

required :total_webhooks, Integer