Class: Lithic::Models::EventSubscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/event_subscription.rb

Defined Under Namespace

Modules: EventType

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(token:, description:, disabled:, url:, event_types: nil) ⇒ Object

A subscription to specific event types.

Parameters:

  • token (String) —

    Globally unique identifier.

  • description (String) —

    A description of the subscription.

  • disabled (Boolean) —

    Whether the subscription is disabled.

  • url (String)
  • event_types (Array<Symbol, Lithic::Models::EventSubscription::EventType>, nil) (defaults to: nil) 



# File 'lib/lithic/models/event_subscription.rb', line 36

Instance Attribute Details

#description ⇒ String

A description of the subscription.

Returns:

  • (String) 


16
 
# File 'lib/lithic/models/event_subscription.rb', line 16

required :description, String

#disabled ⇒ Boolean

Whether the subscription is disabled.

Returns:

  • (Boolean) 


22
 
# File 'lib/lithic/models/event_subscription.rb', line 22

required :disabled, Lithic::Internal::Type::Boolean

#event_types ⇒ Array<Symbol, Lithic::Models::EventSubscription::EventType>?

Returns:



32
33
34
 
# File 'lib/lithic/models/event_subscription.rb', line 32

optional :event_types,
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::EventSubscription::EventType] },
nil?: true

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


10
 
# File 'lib/lithic/models/event_subscription.rb', line 10

required :token, String

#url ⇒ String

Returns:

  • (String) 


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

required :url, String