Class: Dodopayments::Models::WebhookCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/webhook_create_params.rb

Overview

See Also:

• Resources::Webhooks#create

Instance Attribute Summary

• #description ⇒ String^?
• #disabled ⇒ Boolean^?

  Create the webhook in a disabled state.

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

  Filter events to the webhook.

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

  Custom headers to be passed.

• #idempotency_key ⇒ String^?

  The request’s idempotency key.

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

  Metadata to be passed to the webhook Defaut is {}.

• #rate_limit ⇒ Integer^?
• #url ⇒ String

  Url of the webhook.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

  Some parameter documentations has been truncated, see WebhookCreateParams 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(url: , description: nil, disabled: nil, filter_types: nil, headers: nil, idempotency_key: nil, metadata: nil, rate_limit: nil, request_options: {}) ⇒ Object

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

Parameters:

• url (String) (defaults to: ) —

  Url of the webhook

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

  Create the webhook in a disabled state.

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

  Filter events to the webhook.

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

  Custom headers to be passed

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

  The request’s idempotency key

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

  Metadata to be passed to the webhook

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

# File 'lib/dodopayments/models/webhook_create_params.rb', line 60

Instance Attribute Details

#description ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/webhook_create_params.rb', line 19

optional :description, String, nil?: true

#disabled ⇒ Boolean^?

Create the webhook in a disabled state.

Default is false

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/webhook_create_params.rb', line 27

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

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

Filter events to the webhook.

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

Returns:

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

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

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

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

Custom headers to be passed

Returns:

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

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

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

#idempotency_key ⇒ String^?

The request’s idempotency key

Returns:

• (String, nil)

# File 'lib/dodopayments/models/webhook_create_params.rb', line 47

optional :idempotency_key, String, nil?: true

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

Metadata to be passed to the webhook Defaut is {}

Returns:

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

# File 'lib/dodopayments/models/webhook_create_params.rb', line 53

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

#rate_limit ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/webhook_create_params.rb', line 58

optional :rate_limit, Integer, nil?: true

#url ⇒ String

Url of the webhook

Returns:

• (String)

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

required :url, String