Class: Lithic::Models::TransactionMonitoring::CaseUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/transaction_monitoring/case_update_params.rb,
sig/lithic/models/transaction_monitoring/case_update_params.rbs

Overview

See Also:

  • Lithic::Resources::TransactionMonitoring::Cases#update

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(case_token:, actor_token: nil, assignee: nil, priority: nil, resolution: nil, resolution_notes: nil, sla_deadline: nil, status: nil, tags: nil, title: nil, request_options: {}) ⇒ Object

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

Parameters:

  • case_token (String)
  • actor_token (String) (defaults to: nil) —

    Optional client-provided identifier for the actor performing this action,

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

    New assignee for the case, or null to unassign

  • priority (Symbol, Lithic::Models::TransactionMonitoring::CasePriority) (defaults to: nil) —

    Priority level of a case, controlling queue ordering and SLA urgency

  • resolution (Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome) (defaults to: nil) —

    Outcome recorded when a case is resolved:

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

    Notes describing the resolution

  • sla_deadline (Time, nil) (defaults to: nil) —

    New SLA deadline for the case, or null to clear it

  • status (Symbol, Lithic::Models::TransactionMonitoring::CaseStatus) (defaults to: nil) —

    Status of a case as it progresses through the review workflow:

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

    Arbitrary key-value metadata to set on the case

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

    New title for the case, or null to clear it

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



# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 88

Instance Attribute Details

#actor_token ⇒ String?

Optional client-provided identifier for the actor performing this action, recorded on the resulting activity entry. This value is supplied by the client (for example, your own internal user ID) and is not authenticated by Lithic

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :actor_token, String

#assignee ⇒ String?

New assignee for the case, or null to unassign

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


28
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 28

optional :assignee, String, nil?: true

#case_token ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 14

required :case_token, String

#priority ⇒ Symbol, ...

Priority level of a case, controlling queue ordering and SLA urgency

Returns:



34
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 34

optional :priority, enum: -> { Lithic::TransactionMonitoring::CasePriority }

#resolution ⇒ Symbol, ...

Outcome recorded when a case is resolved:

  • CONFIRMED_FRAUD - The reviewed activity was confirmed to be fraudulent
  • SUSPICIOUS_ACTIVITY - The activity is suspicious but not confirmed fraud
  • FALSE_POSITIVE - The activity was legitimate and the alert was a false positive
  • NO_ACTION_REQUIRED - No further action is required
  • ESCALATED_EXTERNAL - The case was escalated to an external party

Returns:



47
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 47

optional :resolution, enum: -> { Lithic::TransactionMonitoring::ResolutionOutcome }

#resolution_notes ⇒ String?

Notes describing the resolution

Parameters:

  • (String)

Returns:

  • (String, nil) 


53
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 53

optional :resolution_notes, String

#sla_deadline ⇒ Time?

New SLA deadline for the case, or null to clear it

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


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

optional :sla_deadline, Time, nil?: true

#status ⇒ Symbol, ...

Status of a case as it progresses through the review workflow:

  • OPEN - The case has been created and is still collecting matching transactions
  • ASSIGNED - An analyst has been assigned and transaction collection has stopped
  • IN_REVIEW - The case is actively being investigated
  • ESCALATED - The case has been reviewed and requires additional oversight
  • RESOLVED - A determination has been made and a resolution recorded
  • CLOSED - The case is finalized

Returns:



74
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 74

optional :status, enum: -> { Lithic::TransactionMonitoring::CaseStatus }

#tags ⇒ Hash{Symbol=>String}?

Arbitrary key-value metadata to set on the case

Parameters:

  • (::Hash[Symbol, String])

Returns:

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


80
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 80

optional :tags, Lithic::Internal::Type::HashOf[String]

#title ⇒ String?

New title for the case, or null to clear it

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


86
 
# File 'lib/lithic/models/transaction_monitoring/case_update_params.rb', line 86

optional :title, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


75
 
# File 'sig/lithic/models/transaction_monitoring/case_update_params.rbs', line 75

def to_hash: -> {