Class: Increase::Models::EntityUpdateParams::RiskRating

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_update_params.rb

Defined Under Namespace

Modules: Rating

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(rated_at: , rating: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntityUpdateParams::RiskRating for more details.

An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering.

Parameters:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/increase/models/entity_update_params.rb', line 34

class RiskRating < Increase::Internal::Type::BaseModel
  # @!attribute rated_at
  #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
  #   rating was performed.
  #
  #   @return [Time]
  required :rated_at, Time

  # @!attribute rating
  #   The rating given to this entity.
  #
  #   @return [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
  required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }

  # @!method initialize(rated_at:, rating:)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::EntityUpdateParams::RiskRating} for more details.
  #
  #   An assessment of the entity’s potential risk of involvement in financial crimes,
  #   such as money laundering.
  #
  #   @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
  #
  #   @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating] The rating given to this entity.

  # The rating given to this entity.
  #
  # @see Increase::Models::EntityUpdateParams::RiskRating#rating
  module Rating
    extend Increase::Internal::Type::Enum

    # Low
    LOW = :low

    # Medium
    MEDIUM = :medium

    # High
    HIGH = :high

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#rated_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed.

Returns:

  • (Time) 


40
 
# File 'lib/increase/models/entity_update_params.rb', line 40

required :rated_at, Time

#rating ⇒ Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating

The rating given to this entity.

Returns:



46
 
# File 'lib/increase/models/entity_update_params.rb', line 46

required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }