Class: Lithic::Models::Events::SubscriptionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::Events::SubscriptionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/lithic/models/events/subscription_create_params.rb

Overview

See Also:

• Resources::Events::Subscriptions#create

Defined Under Namespace

Modules: EventType

Instance Attribute Summary

• #description ⇒ String^?

  Event subscription description.

• #disabled ⇒ Boolean^?

  Whether the event subscription is active (false) or inactive (true).

• #event_types ⇒ Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>^?

  Indicates types of events that will be sent to this subscription.

• #url ⇒ String

  URL to which event webhooks will be sent.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

  Some parameter documentations has been truncated, see SubscriptionCreateParams 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, event_types: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::Events::SubscriptionCreateParams for more details.

Parameters:

• url (String) —

  URL to which event webhooks will be sent. URL must be a valid HTTPS address.

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

  Event subscription description.

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

  Whether the event subscription is active (false) or inactive (true).

• event_types (Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>) (defaults to: nil) —

  Indicates types of events that will be sent to this subscription. If left blank,

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

# File 'lib/lithic/models/events/subscription_create_params.rb', line 37

Instance Attribute Details

#description ⇒ String^?

Event subscription description.

Returns:

• (String, nil)

# File 'lib/lithic/models/events/subscription_create_params.rb', line 21

optional :description, String

#disabled ⇒ Boolean^?

Whether the event subscription is active (false) or inactive (true).

Returns:

• (Boolean, nil)

# File 'lib/lithic/models/events/subscription_create_params.rb', line 27

optional :disabled, Lithic::Internal::Type::Boolean

#event_types ⇒ Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>^?

Indicates types of events that will be sent to this subscription. If left blank, all types will be sent.

Returns:

• (Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>, nil)

# File 'lib/lithic/models/events/subscription_create_params.rb', line 34

optional :event_types,
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Events::SubscriptionCreateParams::EventType] }

#url ⇒ String

URL to which event webhooks will be sent. URL must be a valid HTTPS address.

Returns:

• (String)

# File 'lib/lithic/models/events/subscription_create_params.rb', line 15

required :url, String