Class: Dodopayments::Models::WebhookDetails

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/webhook_details.rb

Overview

See Also:

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(id: , created_at: , description: , metadata: , updated_at: , url: , disabled: nil, filter_types: nil, rate_limit: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::WebhookDetails for more details.

Parameters:

  • id (String) (defaults to: ) —

    The webhook’s ID.

  • created_at (String) (defaults to: ) —

    Created at timestamp

  • description (String) (defaults to: ) —

    An example webhook name.

  • metadata (Hash{Symbol=>String}) (defaults to: ) —

    Metadata of the webhook

  • updated_at (String) (defaults to: ) —

    Updated at timestamp

  • url (String) (defaults to: ) —

    Url endpoint of the webhook

  • disabled (Boolean, nil) (defaults to: nil) —

    Status of the webhook.

  • filter_types (Array<String>, nil) (defaults to: nil) —

    Filter events to the webhook.

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

    Configured rate limit




# File 'lib/dodopayments/models/webhook_details.rb', line 65

Instance Attribute Details

#created_at ⇒ String

Created at timestamp

Returns:

  • (String) 


17
 
# File 'lib/dodopayments/models/webhook_details.rb', line 17

required :created_at, String

#description ⇒ String

An example webhook name.

Returns:

  • (String) 


23
 
# File 'lib/dodopayments/models/webhook_details.rb', line 23

required :description, String

#disabled ⇒ Boolean?

Status of the webhook.

If true, events are not sent

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/dodopayments/models/webhook_details.rb', line 49

optional :disabled, Dodopayments::Internal::Type::Boolean, nil?: true

#filter_types ⇒ Array<String>?

Filter events to the webhook.

Webhook event will only be sent for events in the list.

Returns:

  • (Array<String>, nil) 


57
 
# File 'lib/dodopayments/models/webhook_details.rb', line 57

optional :filter_types, Dodopayments::Internal::Type::ArrayOf[String], nil?: true

#id ⇒ String

The webhook’s ID.

Returns:

  • (String) 


11
 
# File 'lib/dodopayments/models/webhook_details.rb', line 11

required :id, String

#metadata ⇒ Hash{Symbol=>String}

Metadata of the webhook

Returns:

  • (Hash{Symbol=>String}) 


29
 
# File 'lib/dodopayments/models/webhook_details.rb', line 29

required :metadata, Dodopayments::Internal::Type::HashOf[String]

#rate_limit ⇒ Integer?

Configured rate limit

Returns:

  • (Integer, nil) 


63
 
# File 'lib/dodopayments/models/webhook_details.rb', line 63

optional :rate_limit, Integer, nil?: true

#updated_at ⇒ String

Updated at timestamp

Returns:

  • (String) 


35
 
# File 'lib/dodopayments/models/webhook_details.rb', line 35

required :updated_at, String

#url ⇒ String

Url endpoint of the webhook

Returns:

  • (String) 


41
 
# File 'lib/dodopayments/models/webhook_details.rb', line 41

required :url, String