increase 1.63.0 → 1.65.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 716171a8d1f7b05eebb131c05d5b187c128dc0c54a6545d33c3565ad2a5044dc
4
- data.tar.gz: 451194a4710e08f5354e40d834148aab4464ef586ceb2c1cbb8020c0f8057f1e
3
+ metadata.gz: 5c9e7d2f1ef63512112a8b2a87d64966826584640f9cb49683ccaf79562c4447
4
+ data.tar.gz: 54eba55f6851d3cc8729bee1788e1bda14e58c3f2ded96c51934d4fc4cd0e6d7
5
5
  SHA512:
6
- metadata.gz: 1dd0f6f03ed2188c7dd6ebdda1f3380a27ca2c09bb1166a295ab93814ef14801bb1062c631ff03241bd50ee7fa9c6fc6c01533f9a8911bfe7bb0cac37d0cbf38
7
- data.tar.gz: b05d875939df12111cd73a66e0d42f351c9f056d7eabc53a9a3b786b56b7c64857078473dbe06dc6a1a2eb8b0f5b936dca42ce65a1bc997092e59c7db164f5dc
6
+ metadata.gz: 50e8f5b2d156f03522c1ee09a5d494cd34090e510eb074faa9e6fab18fe7fa3cdac3b7b00252b70debabad3e06f9738b9ef651d1bd72bef217d0d425acbe2dbe
7
+ data.tar.gz: '084aaf9489dd09f8c22943e659522dcd1acef332093845e07f08bbea5afc31baaf19e011300ffd00d9e98962e56ceb3b4c342a879b914d61ad3e03b594ed99bb'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.65.0 (2025-09-05)
4
+
5
+ Full Changelog: [v1.64.0...v1.65.0](https://github.com/Increase/increase-ruby/compare/v1.64.0...v1.65.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([ebb31b6](https://github.com/Increase/increase-ruby/commit/ebb31b6d4f44e5148de250a6231a96bdd2d978bd))
10
+
11
+ ## 1.64.0 (2025-09-04)
12
+
13
+ Full Changelog: [v1.63.0...v1.64.0](https://github.com/Increase/increase-ruby/compare/v1.63.0...v1.64.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([8a7c3b9](https://github.com/Increase/increase-ruby/commit/8a7c3b9792f9aa78a9193f3594ab20f3793de872))
18
+
3
19
  ## 1.63.0 (2025-09-04)
4
20
 
5
21
  Full Changelog: [v1.62.0...v1.63.0](https://github.com/Increase/increase-ruby/compare/v1.62.0...v1.63.0)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "increase", "~> 1.63.0"
18
+ gem "increase", "~> 1.65.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -65,6 +65,13 @@ module Increase
65
65
  # @return [Increase::Models::Entity::NaturalPerson, nil]
66
66
  required :natural_person, -> { Increase::Entity::NaturalPerson }, nil?: true
67
67
 
68
+ # @!attribute risk_rating
69
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
70
+ # such as money laundering.
71
+ #
72
+ # @return [Increase::Models::Entity::RiskRating, nil]
73
+ required :risk_rating, -> { Increase::Entity::RiskRating }, nil?: true
74
+
68
75
  # @!attribute status
69
76
  # The status of the entity.
70
77
  #
@@ -106,7 +113,7 @@ module Increase
106
113
  # @return [Symbol, Increase::Models::Entity::Type]
107
114
  required :type, enum: -> { Increase::Entity::Type }
108
115
 
109
- # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, status:, structure:, supplemental_documents:, third_party_verification:, trust:, type:)
116
+ # @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, third_party_verification:, trust:, type:)
110
117
  # Some parameter documentations has been truncated, see {Increase::Models::Entity}
111
118
  # for more details.
112
119
  #
@@ -131,6 +138,8 @@ module Increase
131
138
  #
132
139
  # @param natural_person [Increase::Models::Entity::NaturalPerson, nil] Details of the natural person entity. Will be present if `structure` is equal to
133
140
  #
141
+ # @param risk_rating [Increase::Models::Entity::RiskRating, nil] An assessment of the entity’s potential risk of involvement in financial crimes,
142
+ #
134
143
  # @param status [Symbol, Increase::Models::Entity::Status] The status of the entity.
135
144
  #
136
145
  # @param structure [Symbol, Increase::Models::Entity::Structure] The entity's legal structure.
@@ -919,6 +928,52 @@ module Increase
919
928
  end
920
929
  end
921
930
 
931
+ # @see Increase::Models::Entity#risk_rating
932
+ class RiskRating < Increase::Internal::Type::BaseModel
933
+ # @!attribute rated_at
934
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
935
+ # rating was performed.
936
+ #
937
+ # @return [Time]
938
+ required :rated_at, Time
939
+
940
+ # @!attribute rating
941
+ # The rating given to this entity.
942
+ #
943
+ # @return [Symbol, Increase::Models::Entity::RiskRating::Rating]
944
+ required :rating, enum: -> { Increase::Entity::RiskRating::Rating }
945
+
946
+ # @!method initialize(rated_at:, rating:)
947
+ # Some parameter documentations has been truncated, see
948
+ # {Increase::Models::Entity::RiskRating} for more details.
949
+ #
950
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
951
+ # such as money laundering.
952
+ #
953
+ # @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
954
+ #
955
+ # @param rating [Symbol, Increase::Models::Entity::RiskRating::Rating] The rating given to this entity.
956
+
957
+ # The rating given to this entity.
958
+ #
959
+ # @see Increase::Models::Entity::RiskRating#rating
960
+ module Rating
961
+ extend Increase::Internal::Type::Enum
962
+
963
+ # Low
964
+ LOW = :low
965
+
966
+ # Medium
967
+ MEDIUM = :medium
968
+
969
+ # High
970
+ HIGH = :high
971
+
972
+ # @!method self.values
973
+ # @return [Array<Symbol>]
974
+ end
975
+ end
976
+
922
977
  # The status of the entity.
923
978
  #
924
979
  # @see Increase::Models::Entity#status
@@ -49,6 +49,13 @@ module Increase
49
49
  # @return [Increase::Models::EntityCreateParams::NaturalPerson, nil]
50
50
  optional :natural_person, -> { Increase::EntityCreateParams::NaturalPerson }
51
51
 
52
+ # @!attribute risk_rating
53
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
54
+ # such as money laundering.
55
+ #
56
+ # @return [Increase::Models::EntityCreateParams::RiskRating, nil]
57
+ optional :risk_rating, -> { Increase::EntityCreateParams::RiskRating }
58
+
52
59
  # @!attribute supplemental_documents
53
60
  # Additional documentation associated with the entity.
54
61
  #
@@ -70,7 +77,7 @@ module Increase
70
77
  # @return [Increase::Models::EntityCreateParams::Trust, nil]
71
78
  optional :trust, -> { Increase::EntityCreateParams::Trust }
72
79
 
73
- # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {})
80
+ # @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {})
74
81
  # Some parameter documentations has been truncated, see
75
82
  # {Increase::Models::EntityCreateParams} for more details.
76
83
  #
@@ -86,6 +93,8 @@ module Increase
86
93
  #
87
94
  # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal
88
95
  #
96
+ # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
97
+ #
89
98
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
90
99
  #
91
100
  # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
@@ -1436,6 +1445,51 @@ module Increase
1436
1445
  end
1437
1446
  end
1438
1447
 
1448
+ class RiskRating < Increase::Internal::Type::BaseModel
1449
+ # @!attribute rated_at
1450
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1451
+ # rating was performed.
1452
+ #
1453
+ # @return [Time]
1454
+ required :rated_at, Time
1455
+
1456
+ # @!attribute rating
1457
+ # The rating given to this entity.
1458
+ #
1459
+ # @return [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating]
1460
+ required :rating, enum: -> { Increase::EntityCreateParams::RiskRating::Rating }
1461
+
1462
+ # @!method initialize(rated_at:, rating:)
1463
+ # Some parameter documentations has been truncated, see
1464
+ # {Increase::Models::EntityCreateParams::RiskRating} for more details.
1465
+ #
1466
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
1467
+ # such as money laundering.
1468
+ #
1469
+ # @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
1470
+ #
1471
+ # @param rating [Symbol, Increase::Models::EntityCreateParams::RiskRating::Rating] The rating given to this entity.
1472
+
1473
+ # The rating given to this entity.
1474
+ #
1475
+ # @see Increase::Models::EntityCreateParams::RiskRating#rating
1476
+ module Rating
1477
+ extend Increase::Internal::Type::Enum
1478
+
1479
+ # Low
1480
+ LOW = :low
1481
+
1482
+ # Medium
1483
+ MEDIUM = :medium
1484
+
1485
+ # High
1486
+ HIGH = :high
1487
+
1488
+ # @!method self.values
1489
+ # @return [Array<Symbol>]
1490
+ end
1491
+ end
1492
+
1439
1493
  class SupplementalDocument < Increase::Internal::Type::BaseModel
1440
1494
  # @!attribute file_id
1441
1495
  # The identifier of the File containing the document.
@@ -0,0 +1,205 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Increase
4
+ module Models
5
+ # @see Increase::Resources::Entities#update
6
+ class EntityUpdateParams < Increase::Internal::Type::BaseModel
7
+ extend Increase::Internal::Type::RequestParameters::Converter
8
+ include Increase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute corporation
11
+ # Details of the corporation entity to update.
12
+ #
13
+ # @return [Increase::Models::EntityUpdateParams::Corporation, nil]
14
+ optional :corporation, -> { Increase::EntityUpdateParams::Corporation }
15
+
16
+ # @!attribute government_authority
17
+ # Details of the government authority entity to update.
18
+ #
19
+ # @return [Increase::Models::EntityUpdateParams::GovernmentAuthority, nil]
20
+ optional :government_authority, -> { Increase::EntityUpdateParams::GovernmentAuthority }
21
+
22
+ # @!attribute natural_person
23
+ # Details of the natural person entity to update.
24
+ #
25
+ # @return [Increase::Models::EntityUpdateParams::NaturalPerson, nil]
26
+ optional :natural_person, -> { Increase::EntityUpdateParams::NaturalPerson }
27
+
28
+ # @!attribute risk_rating
29
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
30
+ # such as money laundering.
31
+ #
32
+ # @return [Increase::Models::EntityUpdateParams::RiskRating, nil]
33
+ optional :risk_rating, -> { Increase::EntityUpdateParams::RiskRating }
34
+
35
+ # @!attribute third_party_verification
36
+ # A reference to data stored in a third-party verification service. Your
37
+ # integration may or may not use this field.
38
+ #
39
+ # @return [Increase::Models::EntityUpdateParams::ThirdPartyVerification, nil]
40
+ optional :third_party_verification, -> { Increase::EntityUpdateParams::ThirdPartyVerification }
41
+
42
+ # @!attribute trust
43
+ # Details of the trust entity to update.
44
+ #
45
+ # @return [Increase::Models::EntityUpdateParams::Trust, nil]
46
+ optional :trust, -> { Increase::EntityUpdateParams::Trust }
47
+
48
+ # @!method initialize(corporation: nil, government_authority: nil, natural_person: nil, risk_rating: nil, third_party_verification: nil, trust: nil, request_options: {})
49
+ # Some parameter documentations has been truncated, see
50
+ # {Increase::Models::EntityUpdateParams} for more details.
51
+ #
52
+ # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update.
53
+ #
54
+ # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update.
55
+ #
56
+ # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update.
57
+ #
58
+ # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
59
+ #
60
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
61
+ #
62
+ # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update.
63
+ #
64
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
65
+
66
+ class Corporation < Increase::Internal::Type::BaseModel
67
+ # @!attribute name
68
+ # The legal name of the corporation.
69
+ #
70
+ # @return [String, nil]
71
+ optional :name, String
72
+
73
+ # @!method initialize(name: nil)
74
+ # Details of the corporation entity to update.
75
+ #
76
+ # @param name [String] The legal name of the corporation.
77
+ end
78
+
79
+ class GovernmentAuthority < Increase::Internal::Type::BaseModel
80
+ # @!attribute name
81
+ # The legal name of the government authority.
82
+ #
83
+ # @return [String, nil]
84
+ optional :name, String
85
+
86
+ # @!method initialize(name: nil)
87
+ # Details of the government authority entity to update.
88
+ #
89
+ # @param name [String] The legal name of the government authority.
90
+ end
91
+
92
+ class NaturalPerson < Increase::Internal::Type::BaseModel
93
+ # @!attribute name
94
+ # The legal name of the natural person.
95
+ #
96
+ # @return [String, nil]
97
+ optional :name, String
98
+
99
+ # @!method initialize(name: nil)
100
+ # Details of the natural person entity to update.
101
+ #
102
+ # @param name [String] The legal name of the natural person.
103
+ end
104
+
105
+ class RiskRating < Increase::Internal::Type::BaseModel
106
+ # @!attribute rated_at
107
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
108
+ # rating was performed.
109
+ #
110
+ # @return [Time]
111
+ required :rated_at, Time
112
+
113
+ # @!attribute rating
114
+ # The rating given to this entity.
115
+ #
116
+ # @return [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
117
+ required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }
118
+
119
+ # @!method initialize(rated_at:, rating:)
120
+ # Some parameter documentations has been truncated, see
121
+ # {Increase::Models::EntityUpdateParams::RiskRating} for more details.
122
+ #
123
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
124
+ # such as money laundering.
125
+ #
126
+ # @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
127
+ #
128
+ # @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating] The rating given to this entity.
129
+
130
+ # The rating given to this entity.
131
+ #
132
+ # @see Increase::Models::EntityUpdateParams::RiskRating#rating
133
+ module Rating
134
+ extend Increase::Internal::Type::Enum
135
+
136
+ # Low
137
+ LOW = :low
138
+
139
+ # Medium
140
+ MEDIUM = :medium
141
+
142
+ # High
143
+ HIGH = :high
144
+
145
+ # @!method self.values
146
+ # @return [Array<Symbol>]
147
+ end
148
+ end
149
+
150
+ class ThirdPartyVerification < Increase::Internal::Type::BaseModel
151
+ # @!attribute reference
152
+ # The reference identifier for the third party verification.
153
+ #
154
+ # @return [String]
155
+ required :reference, String
156
+
157
+ # @!attribute vendor
158
+ # The vendor that was used to perform the verification.
159
+ #
160
+ # @return [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor]
161
+ required :vendor, enum: -> { Increase::EntityUpdateParams::ThirdPartyVerification::Vendor }
162
+
163
+ # @!method initialize(reference:, vendor:)
164
+ # A reference to data stored in a third-party verification service. Your
165
+ # integration may or may not use this field.
166
+ #
167
+ # @param reference [String] The reference identifier for the third party verification.
168
+ #
169
+ # @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
170
+
171
+ # The vendor that was used to perform the verification.
172
+ #
173
+ # @see Increase::Models::EntityUpdateParams::ThirdPartyVerification#vendor
174
+ module Vendor
175
+ extend Increase::Internal::Type::Enum
176
+
177
+ # Alloy. See https://alloy.com for more information.
178
+ ALLOY = :alloy
179
+
180
+ # Middesk. See https://middesk.com for more information.
181
+ MIDDESK = :middesk
182
+
183
+ # Oscilar. See https://oscilar.com for more information.
184
+ OSCILAR = :oscilar
185
+
186
+ # @!method self.values
187
+ # @return [Array<Symbol>]
188
+ end
189
+ end
190
+
191
+ class Trust < Increase::Internal::Type::BaseModel
192
+ # @!attribute name
193
+ # The legal name of the trust.
194
+ #
195
+ # @return [String, nil]
196
+ optional :name, String
197
+
198
+ # @!method initialize(name: nil)
199
+ # Details of the trust entity to update.
200
+ #
201
+ # @param name [String] The legal name of the trust.
202
+ end
203
+ end
204
+ end
205
+ end
@@ -275,6 +275,8 @@ module Increase
275
275
 
276
276
  EntityUpdateIndustryCodeParams = Increase::Models::EntityUpdateIndustryCodeParams
277
277
 
278
+ EntityUpdateParams = Increase::Models::EntityUpdateParams
279
+
278
280
  Event = Increase::Models::Event
279
281
 
280
282
  EventListParams = Increase::Models::EventListParams
@@ -8,7 +8,7 @@ module Increase
8
8
  #
9
9
  # Create an Entity
10
10
  #
11
- # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {})
11
+ # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, third_party_verification: nil, trust: nil, request_options: {})
12
12
  #
13
13
  # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
14
14
  #
@@ -22,6 +22,8 @@ module Increase
22
22
  #
23
23
  # @param natural_person [Increase::Models::EntityCreateParams::NaturalPerson] Details of the natural person entity to create. Required if `structure` is equal
24
24
  #
25
+ # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
26
+ #
25
27
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
26
28
  #
27
29
  # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
@@ -64,6 +66,43 @@ module Increase
64
66
  )
65
67
  end
66
68
 
69
+ # Some parameter documentations has been truncated, see
70
+ # {Increase::Models::EntityUpdateParams} for more details.
71
+ #
72
+ # Update an Entity
73
+ #
74
+ # @overload update(entity_id, corporation: nil, government_authority: nil, natural_person: nil, risk_rating: nil, third_party_verification: nil, trust: nil, request_options: {})
75
+ #
76
+ # @param entity_id [String] The entity identifier.
77
+ #
78
+ # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update.
79
+ #
80
+ # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update.
81
+ #
82
+ # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update.
83
+ #
84
+ # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
85
+ #
86
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
87
+ #
88
+ # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update.
89
+ #
90
+ # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
91
+ #
92
+ # @return [Increase::Models::Entity]
93
+ #
94
+ # @see Increase::Models::EntityUpdateParams
95
+ def update(entity_id, params = {})
96
+ parsed, options = Increase::EntityUpdateParams.dump_request(params)
97
+ @client.request(
98
+ method: :patch,
99
+ path: ["entities/%1$s", entity_id],
100
+ body: parsed,
101
+ model: Increase::Entity,
102
+ options: options
103
+ )
104
+ end
105
+
67
106
  # Some parameter documentations has been truncated, see
68
107
  # {Increase::Models::EntityListParams} for more details.
69
108
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.63.0"
4
+ VERSION = "1.65.0"
5
5
  end
data/lib/increase.rb CHANGED
@@ -169,6 +169,7 @@ require_relative "increase/models/entity_supplemental_document"
169
169
  require_relative "increase/models/entity_update_address_params"
170
170
  require_relative "increase/models/entity_update_beneficial_owner_address_params"
171
171
  require_relative "increase/models/entity_update_industry_code_params"
172
+ require_relative "increase/models/entity_update_params"
172
173
  require_relative "increase/models/event"
173
174
  require_relative "increase/models/event_list_params"
174
175
  require_relative "increase/models/event_retrieve_params"
@@ -74,6 +74,18 @@ module Increase
74
74
  end
75
75
  attr_writer :natural_person
76
76
 
77
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
78
+ # such as money laundering.
79
+ sig { returns(T.nilable(Increase::Entity::RiskRating)) }
80
+ attr_reader :risk_rating
81
+
82
+ sig do
83
+ params(
84
+ risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash)
85
+ ).void
86
+ end
87
+ attr_writer :risk_rating
88
+
77
89
  # The status of the entity.
78
90
  sig { returns(Increase::Entity::Status::TaggedSymbol) }
79
91
  attr_accessor :status
@@ -127,6 +139,7 @@ module Increase
127
139
  idempotency_key: T.nilable(String),
128
140
  joint: T.nilable(Increase::Entity::Joint::OrHash),
129
141
  natural_person: T.nilable(Increase::Entity::NaturalPerson::OrHash),
142
+ risk_rating: T.nilable(Increase::Entity::RiskRating::OrHash),
130
143
  status: Increase::Entity::Status::OrSymbol,
131
144
  structure: Increase::Entity::Structure::OrSymbol,
132
145
  supplemental_documents:
@@ -163,6 +176,9 @@ module Increase
163
176
  # Details of the natural person entity. Will be present if `structure` is equal to
164
177
  # `natural_person`.
165
178
  natural_person:,
179
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
180
+ # such as money laundering.
181
+ risk_rating:,
166
182
  # The status of the entity.
167
183
  status:,
168
184
  # The entity's legal structure.
@@ -195,6 +211,7 @@ module Increase
195
211
  idempotency_key: T.nilable(String),
196
212
  joint: T.nilable(Increase::Entity::Joint),
197
213
  natural_person: T.nilable(Increase::Entity::NaturalPerson),
214
+ risk_rating: T.nilable(Increase::Entity::RiskRating),
198
215
  status: Increase::Entity::Status::TaggedSymbol,
199
216
  structure: Increase::Entity::Structure::TaggedSymbol,
200
217
  supplemental_documents:
@@ -1572,6 +1589,78 @@ module Increase
1572
1589
  end
1573
1590
  end
1574
1591
 
1592
+ class RiskRating < Increase::Internal::Type::BaseModel
1593
+ OrHash =
1594
+ T.type_alias do
1595
+ T.any(Increase::Entity::RiskRating, Increase::Internal::AnyHash)
1596
+ end
1597
+
1598
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1599
+ # rating was performed.
1600
+ sig { returns(Time) }
1601
+ attr_accessor :rated_at
1602
+
1603
+ # The rating given to this entity.
1604
+ sig { returns(Increase::Entity::RiskRating::Rating::TaggedSymbol) }
1605
+ attr_accessor :rating
1606
+
1607
+ # An assessment of the entity’s potential risk of involvement in financial crimes,
1608
+ # such as money laundering.
1609
+ sig do
1610
+ params(
1611
+ rated_at: Time,
1612
+ rating: Increase::Entity::RiskRating::Rating::OrSymbol
1613
+ ).returns(T.attached_class)
1614
+ end
1615
+ def self.new(
1616
+ # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
1617
+ # rating was performed.
1618
+ rated_at:,
1619
+ # The rating given to this entity.
1620
+ rating:
1621
+ )
1622
+ end
1623
+
1624
+ sig do
1625
+ override.returns(
1626
+ {
1627
+ rated_at: Time,
1628
+ rating: Increase::Entity::RiskRating::Rating::TaggedSymbol
1629
+ }
1630
+ )
1631
+ end
1632
+ def to_hash
1633
+ end
1634
+
1635
+ # The rating given to this entity.
1636
+ module Rating
1637
+ extend Increase::Internal::Type::Enum
1638
+
1639
+ TaggedSymbol =
1640
+ T.type_alias { T.all(Symbol, Increase::Entity::RiskRating::Rating) }
1641
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1642
+
1643
+ # Low
1644
+ LOW = T.let(:low, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1645
+
1646
+ # Medium
1647
+ MEDIUM =
1648
+ T.let(:medium, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1649
+
1650
+ # High
1651
+ HIGH =
1652
+ T.let(:high, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1653
+
1654
+ sig do
1655
+ override.returns(
1656
+ T::Array[Increase::Entity::RiskRating::Rating::TaggedSymbol]
1657
+ )
1658
+ end
1659
+ def self.values
1660
+ end
1661
+ end
1662
+ end
1663
+
1575
1664
  # The status of the entity.
1576
1665
  module Status
1577
1666
  extend Increase::Internal::Type::Enum