Class: Lithic::Models::CardPinUpdatedWebhookEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/card_pin_updated_webhook_event.rb,
sig/lithic/models/card_pin_updated_webhook_event.rbs

Defined Under Namespace

Modules: PinStatus, StatusReason

Instance Attribute Summary collapse

Class Method 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(card_token:, pin_status:, status_reason:, event_type: :"card.pin_updated") ⇒ Object

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

Parameters:




# File 'lib/lithic/models/card_pin_updated_webhook_event.rb', line 38

Instance Attribute Details

#card_token ⇒ String

The token of the card whose PIN or PIN status was updated

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :card_token, String

#event_type ⇒ Symbol, :"card.pin_updated"

The type of event that occurred.

Parameters:

  • value (:"card.pin_updated")

Returns:

  • (Symbol, :"card.pin_updated") 


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

required :event_type, const: :"card.pin_updated"

#pin_status ⇒ Symbol, Lithic::Models::CardPinUpdatedWebhookEvent::PinStatus

The card's PIN status after the update

Parameters:

  • value (Lithic::Models::CardPinUpdatedWebhookEvent::pin_status)

Returns:



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

required :pin_status, enum: -> { Lithic::CardPinUpdatedWebhookEvent::PinStatus }

#status_reason ⇒ Symbol, Lithic::Models::CardPinUpdatedWebhookEvent::StatusReason

The reason for the PIN update:

  • PIN_SET - The PIN was set for the first time; pin_status is OK
  • PIN_CHANGED - The PIN was changed, including when changing a blocked PIN; pin_status is OK
  • PIN_UNBLOCKED - The PIN was unblocked without changing it; pin_status is OK
  • EXCESSIVE_PIN_ATTEMPTS - The PIN was blocked due to excessive incorrect PIN attempts; pin_status is BLOCKED

Parameters:

  • value (Lithic::Models::CardPinUpdatedWebhookEvent::status_reason)

Returns:



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

required :status_reason, enum: -> { Lithic::CardPinUpdatedWebhookEvent::StatusReason }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/card_pin_updated_webhook_event.rb', line 59

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/lithic/models/card_pin_updated_webhook_event.rbs', line 27

def to_hash: -> {