Class: Believe::Models::WebhookTriggerEventResponse::Delivery

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

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(deliveries:, event_id:, event_type:, successful_deliveries:, ted_says:, total_webhooks:) ⇒ Object

Response after triggering webhook events.

Parameters:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/believe/models/webhook_trigger_event_response.rb', line 59

class Delivery < ::Believe::Internal::Type::BaseModel
  # @!attribute success
  #   Whether delivery was successful
  #
  #   @return [Boolean]
  required :success, ::Believe::Internal::Type::Boolean

  # @!attribute url
  #   URL the webhook was sent to
  #
  #   @return [String]
  required :url, String

  # @!attribute webhook_id
  #   ID of the webhook
  #
  #   @return [String]
  required :webhook_id, String

  # @!attribute error
  #   Error message if delivery failed
  #
  #   @return [String, nil]
  optional :error, String, nil?: true

  # @!attribute status_code
  #   HTTP status code from the endpoint
  #
  #   @return [Integer, nil]
  optional :status_code, Integer, nil?: true

  # @!method initialize(success:, url:, webhook_id:, error: nil, status_code: nil)
  #   Result of delivering a webhook to a single endpoint.
  #
  #   @param success [Boolean] Whether delivery was successful
  #
  #   @param url [String] URL the webhook was sent to
  #
  #   @param webhook_id [String] ID of the webhook
  #
  #   @param error [String, nil] Error message if delivery failed
  #
  #   @param status_code [Integer, nil] HTTP status code from the endpoint
end

Instance Attribute Details

#error ⇒ String?

Error message if delivery failed

Returns:

  • (String, nil) 


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

optional :error, String, nil?: true

#status_code ⇒ Integer?

HTTP status code from the endpoint

Returns:

  • (Integer, nil) 


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

optional :status_code, Integer, nil?: true

#success ⇒ Boolean

Whether delivery was successful

Returns:

  • (Boolean) 


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

required :success, ::Believe::Internal::Type::Boolean

#url ⇒ String

URL the webhook was sent to

Returns:

  • (String) 


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

required :url, String

#webhook_id ⇒ String

ID of the webhook

Returns:

  • (String) 


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

required :webhook_id, String