Class: Dodopayments::Models::WebhookUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::WebhookUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/webhook_update_params.rb

Overview

See Also:

• Resources::Webhooks#update

Instance Attribute Summary

• #description ⇒ String^?

  Description of the webhook.

• #disabled ⇒ Boolean^?

  To Disable the endpoint, set it to true.

• #filter_types ⇒ Array<Symbol, Dodopayments::Models::WebhookEventType>^?

  Filter events to the endpoint.

• #metadata ⇒ Hash{Symbol=>String}^?

  Metadata.

• #rate_limit ⇒ Integer^?

  Rate limit.

• #url ⇒ String^?

  Url endpoint.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(description: nil, disabled: nil, filter_types: nil, metadata: nil, rate_limit: nil, url: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WebhookUpdateParams for more details.

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(description: nil, disabled: nil, filter_types: nil, metadata: nil, rate_limit: nil, url: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Description of the webhook

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

  To Disable the endpoint, set it to true.

• filter_types (Array<Symbol, Dodopayments::Models::WebhookEventType>, nil) (defaults to: nil) —

  Filter events to the endpoint.

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

  Metadata

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

  Rate limit

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

  Url endpoint

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

# File 'lib/dodopayments/models/webhook_update_params.rb', line 50

Instance Attribute Details

#description ⇒ String^?

Description of the webhook

Returns:

• (String, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 14

optional :description, String, nil?: true

#disabled ⇒ Boolean^?

To Disable the endpoint, set it to true.

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 20

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

#filter_types ⇒ Array<Symbol, Dodopayments::Models::WebhookEventType>^?

Filter events to the endpoint.

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

Returns:

• (Array<Symbol, Dodopayments::Models::WebhookEventType>, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 28

optional :filter_types,
-> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::WebhookEventType] },
nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

Metadata

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 36

optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true

#rate_limit ⇒ Integer^?

Rate limit

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 42

optional :rate_limit, Integer, nil?: true

#url ⇒ String^?

Url endpoint

Returns:

• (String, nil)

# File 'lib/dodopayments/models/webhook_update_params.rb', line 48

optional :url, String, nil?: true