Class: PreludeSDK::Models::VerificationCheckResponse::Metadata

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

Overview

See Also:

  • PreludeSDK::Models::VerificationCheckResponse#metadata

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(correlation_id: nil) ⇒ Metadata

Some parameter documentations has been truncated, see PreludeSDK::Models::VerificationCheckResponse::Metadata for more details.

The metadata for this verification.

Parameters:

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

    A user-defined identifier to correlate this verification with. It is returned in

  • correlation_id: (String) (defaults to: nil) 



# File 'lib/prelude_sdk/models/verification_check_response.rb', line 71

Instance Attribute Details

#correlation_id ⇒ String?

A user-defined identifier to correlate this verification with. It is returned in the response and any webhook events that refer to this verification.

Parameters:

  • (String)

Returns:

  • (String, nil) 


69
 
# File 'lib/prelude_sdk/models/verification_check_response.rb', line 69

optional :correlation_id, String

Instance Method Details

#to_hash ⇒ { correlation_id: String }

Returns:

  • ({ correlation_id: String }) 


70
 
# File 'sig/prelude_sdk/models/verification_check_response.rbs', line 70

def to_hash: -> { correlation_id: String }