increase 1.63.0 → 1.64.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 +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/increase/models/entity.rb +56 -1
- data/lib/increase/models/entity_create_params.rb +55 -1
- data/lib/increase/models/entity_update_params.rb +121 -0
- data/lib/increase/models.rb +2 -0
- data/lib/increase/resources/entities.rb +32 -1
- data/lib/increase/version.rb +1 -1
- data/lib/increase.rb +1 -0
- data/rbi/increase/models/entity.rbi +89 -0
- data/rbi/increase/models/entity_create_params.rbi +108 -0
- data/rbi/increase/models/entity_update_params.rbi +261 -0
- data/rbi/increase/models.rbi +2 -0
- data/rbi/increase/resources/entities.rbi +27 -0
- data/sig/increase/models/entity.rbs +41 -0
- data/sig/increase/models/entity_create_params.rbs +48 -0
- data/sig/increase/models/entity_update_params.rbs +117 -0
- data/sig/increase/models.rbs +2 -0
- data/sig/increase/resources/entities.rbs +8 -0
- metadata +4 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c8b5e9d399f56194de72af40e25b4aabd27adb2335c9511eaf4daee25944ab93
|
4
|
+
data.tar.gz: 8d80daf1e96ea0e91e0cc8d525dbdf0a70cd5c943479447c321969db25969afc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 44febe6946143aee092b5e0e219ef2768ae33c5870b1d77ae8a4365b015723d4fa5a4177ecfb396b0dacbeef5057cd56043cfe25ea8de33a7206e22ce3e93300
|
7
|
+
data.tar.gz: 4dc8e224e8859f4a64d29f1cc86d72570e63e3c0c4b175e89e66be242e2e3a2ac9c0700f8e6022ba27e0572ff27c3ee188dae887ed8084d3ac1586a3d0468e26
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.64.0 (2025-09-04)
|
4
|
+
|
5
|
+
Full Changelog: [v1.63.0...v1.64.0](https://github.com/Increase/increase-ruby/compare/v1.63.0...v1.64.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([8a7c3b9](https://github.com/Increase/increase-ruby/commit/8a7c3b9792f9aa78a9193f3594ab20f3793de872))
|
10
|
+
|
3
11
|
## 1.63.0 (2025-09-04)
|
4
12
|
|
5
13
|
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
@@ -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,121 @@
|
|
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 risk_rating
|
11
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
12
|
+
# such as money laundering.
|
13
|
+
#
|
14
|
+
# @return [Increase::Models::EntityUpdateParams::RiskRating, nil]
|
15
|
+
optional :risk_rating, -> { Increase::EntityUpdateParams::RiskRating }
|
16
|
+
|
17
|
+
# @!attribute third_party_verification
|
18
|
+
# A reference to data stored in a third-party verification service. Your
|
19
|
+
# integration may or may not use this field.
|
20
|
+
#
|
21
|
+
# @return [Increase::Models::EntityUpdateParams::ThirdPartyVerification, nil]
|
22
|
+
optional :third_party_verification, -> { Increase::EntityUpdateParams::ThirdPartyVerification }
|
23
|
+
|
24
|
+
# @!method initialize(risk_rating: nil, third_party_verification: nil, request_options: {})
|
25
|
+
# Some parameter documentations has been truncated, see
|
26
|
+
# {Increase::Models::EntityUpdateParams} for more details.
|
27
|
+
#
|
28
|
+
# @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
|
29
|
+
#
|
30
|
+
# @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
|
31
|
+
#
|
32
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
33
|
+
|
34
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
35
|
+
# @!attribute rated_at
|
36
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
37
|
+
# rating was performed.
|
38
|
+
#
|
39
|
+
# @return [Time]
|
40
|
+
required :rated_at, Time
|
41
|
+
|
42
|
+
# @!attribute rating
|
43
|
+
# The rating given to this entity.
|
44
|
+
#
|
45
|
+
# @return [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating]
|
46
|
+
required :rating, enum: -> { Increase::EntityUpdateParams::RiskRating::Rating }
|
47
|
+
|
48
|
+
# @!method initialize(rated_at:, rating:)
|
49
|
+
# Some parameter documentations has been truncated, see
|
50
|
+
# {Increase::Models::EntityUpdateParams::RiskRating} for more details.
|
51
|
+
#
|
52
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
53
|
+
# such as money laundering.
|
54
|
+
#
|
55
|
+
# @param rated_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk ra
|
56
|
+
#
|
57
|
+
# @param rating [Symbol, Increase::Models::EntityUpdateParams::RiskRating::Rating] The rating given to this entity.
|
58
|
+
|
59
|
+
# The rating given to this entity.
|
60
|
+
#
|
61
|
+
# @see Increase::Models::EntityUpdateParams::RiskRating#rating
|
62
|
+
module Rating
|
63
|
+
extend Increase::Internal::Type::Enum
|
64
|
+
|
65
|
+
# Low
|
66
|
+
LOW = :low
|
67
|
+
|
68
|
+
# Medium
|
69
|
+
MEDIUM = :medium
|
70
|
+
|
71
|
+
# High
|
72
|
+
HIGH = :high
|
73
|
+
|
74
|
+
# @!method self.values
|
75
|
+
# @return [Array<Symbol>]
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
class ThirdPartyVerification < Increase::Internal::Type::BaseModel
|
80
|
+
# @!attribute reference
|
81
|
+
# The reference identifier for the third party verification.
|
82
|
+
#
|
83
|
+
# @return [String]
|
84
|
+
required :reference, String
|
85
|
+
|
86
|
+
# @!attribute vendor
|
87
|
+
# The vendor that was used to perform the verification.
|
88
|
+
#
|
89
|
+
# @return [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor]
|
90
|
+
required :vendor, enum: -> { Increase::EntityUpdateParams::ThirdPartyVerification::Vendor }
|
91
|
+
|
92
|
+
# @!method initialize(reference:, vendor:)
|
93
|
+
# A reference to data stored in a third-party verification service. Your
|
94
|
+
# integration may or may not use this field.
|
95
|
+
#
|
96
|
+
# @param reference [String] The reference identifier for the third party verification.
|
97
|
+
#
|
98
|
+
# @param vendor [Symbol, Increase::Models::EntityUpdateParams::ThirdPartyVerification::Vendor] The vendor that was used to perform the verification.
|
99
|
+
|
100
|
+
# The vendor that was used to perform the verification.
|
101
|
+
#
|
102
|
+
# @see Increase::Models::EntityUpdateParams::ThirdPartyVerification#vendor
|
103
|
+
module Vendor
|
104
|
+
extend Increase::Internal::Type::Enum
|
105
|
+
|
106
|
+
# Alloy. See https://alloy.com for more information.
|
107
|
+
ALLOY = :alloy
|
108
|
+
|
109
|
+
# Middesk. See https://middesk.com for more information.
|
110
|
+
MIDDESK = :middesk
|
111
|
+
|
112
|
+
# Oscilar. See https://oscilar.com for more information.
|
113
|
+
OSCILAR = :oscilar
|
114
|
+
|
115
|
+
# @!method self.values
|
116
|
+
# @return [Array<Symbol>]
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
data/lib/increase/models.rb
CHANGED
@@ -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,35 @@ 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, risk_rating: nil, third_party_verification: nil, request_options: {})
|
75
|
+
#
|
76
|
+
# @param entity_id [String] The entity identifier.
|
77
|
+
#
|
78
|
+
# @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
|
79
|
+
#
|
80
|
+
# @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
|
81
|
+
#
|
82
|
+
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
83
|
+
#
|
84
|
+
# @return [Increase::Models::Entity]
|
85
|
+
#
|
86
|
+
# @see Increase::Models::EntityUpdateParams
|
87
|
+
def update(entity_id, params = {})
|
88
|
+
parsed, options = Increase::EntityUpdateParams.dump_request(params)
|
89
|
+
@client.request(
|
90
|
+
method: :patch,
|
91
|
+
path: ["entities/%1$s", entity_id],
|
92
|
+
body: parsed,
|
93
|
+
model: Increase::Entity,
|
94
|
+
options: options
|
95
|
+
)
|
96
|
+
end
|
97
|
+
|
67
98
|
# Some parameter documentations has been truncated, see
|
68
99
|
# {Increase::Models::EntityListParams} for more details.
|
69
100
|
#
|
data/lib/increase/version.rb
CHANGED
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
|
@@ -71,6 +71,18 @@ module Increase
|
|
71
71
|
end
|
72
72
|
attr_writer :natural_person
|
73
73
|
|
74
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
75
|
+
# such as money laundering.
|
76
|
+
sig { returns(T.nilable(Increase::EntityCreateParams::RiskRating)) }
|
77
|
+
attr_reader :risk_rating
|
78
|
+
|
79
|
+
sig do
|
80
|
+
params(
|
81
|
+
risk_rating: Increase::EntityCreateParams::RiskRating::OrHash
|
82
|
+
).void
|
83
|
+
end
|
84
|
+
attr_writer :risk_rating
|
85
|
+
|
74
86
|
# Additional documentation associated with the entity.
|
75
87
|
sig do
|
76
88
|
returns(
|
@@ -121,6 +133,7 @@ module Increase
|
|
121
133
|
Increase::EntityCreateParams::GovernmentAuthority::OrHash,
|
122
134
|
joint: Increase::EntityCreateParams::Joint::OrHash,
|
123
135
|
natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
|
136
|
+
risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
|
124
137
|
supplemental_documents:
|
125
138
|
T::Array[
|
126
139
|
Increase::EntityCreateParams::SupplementalDocument::OrHash
|
@@ -150,6 +163,9 @@ module Increase
|
|
150
163
|
# `social_security_number` or `individual_taxpayer_identification_number`
|
151
164
|
# identification methods.
|
152
165
|
natural_person: nil,
|
166
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
167
|
+
# such as money laundering.
|
168
|
+
risk_rating: nil,
|
153
169
|
# Additional documentation associated with the entity.
|
154
170
|
supplemental_documents: nil,
|
155
171
|
# A reference to data stored in a third-party verification service. Your
|
@@ -172,6 +188,7 @@ module Increase
|
|
172
188
|
Increase::EntityCreateParams::GovernmentAuthority,
|
173
189
|
joint: Increase::EntityCreateParams::Joint,
|
174
190
|
natural_person: Increase::EntityCreateParams::NaturalPerson,
|
191
|
+
risk_rating: Increase::EntityCreateParams::RiskRating,
|
175
192
|
supplemental_documents:
|
176
193
|
T::Array[Increase::EntityCreateParams::SupplementalDocument],
|
177
194
|
third_party_verification:
|
@@ -2630,6 +2647,97 @@ module Increase
|
|
2630
2647
|
end
|
2631
2648
|
end
|
2632
2649
|
|
2650
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
2651
|
+
OrHash =
|
2652
|
+
T.type_alias do
|
2653
|
+
T.any(
|
2654
|
+
Increase::EntityCreateParams::RiskRating,
|
2655
|
+
Increase::Internal::AnyHash
|
2656
|
+
)
|
2657
|
+
end
|
2658
|
+
|
2659
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
2660
|
+
# rating was performed.
|
2661
|
+
sig { returns(Time) }
|
2662
|
+
attr_accessor :rated_at
|
2663
|
+
|
2664
|
+
# The rating given to this entity.
|
2665
|
+
sig do
|
2666
|
+
returns(Increase::EntityCreateParams::RiskRating::Rating::OrSymbol)
|
2667
|
+
end
|
2668
|
+
attr_accessor :rating
|
2669
|
+
|
2670
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
2671
|
+
# such as money laundering.
|
2672
|
+
sig do
|
2673
|
+
params(
|
2674
|
+
rated_at: Time,
|
2675
|
+
rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
|
2676
|
+
).returns(T.attached_class)
|
2677
|
+
end
|
2678
|
+
def self.new(
|
2679
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
2680
|
+
# rating was performed.
|
2681
|
+
rated_at:,
|
2682
|
+
# The rating given to this entity.
|
2683
|
+
rating:
|
2684
|
+
)
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
sig do
|
2688
|
+
override.returns(
|
2689
|
+
{
|
2690
|
+
rated_at: Time,
|
2691
|
+
rating: Increase::EntityCreateParams::RiskRating::Rating::OrSymbol
|
2692
|
+
}
|
2693
|
+
)
|
2694
|
+
end
|
2695
|
+
def to_hash
|
2696
|
+
end
|
2697
|
+
|
2698
|
+
# The rating given to this entity.
|
2699
|
+
module Rating
|
2700
|
+
extend Increase::Internal::Type::Enum
|
2701
|
+
|
2702
|
+
TaggedSymbol =
|
2703
|
+
T.type_alias do
|
2704
|
+
T.all(Symbol, Increase::EntityCreateParams::RiskRating::Rating)
|
2705
|
+
end
|
2706
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2707
|
+
|
2708
|
+
# Low
|
2709
|
+
LOW =
|
2710
|
+
T.let(
|
2711
|
+
:low,
|
2712
|
+
Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
|
2713
|
+
)
|
2714
|
+
|
2715
|
+
# Medium
|
2716
|
+
MEDIUM =
|
2717
|
+
T.let(
|
2718
|
+
:medium,
|
2719
|
+
Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
|
2720
|
+
)
|
2721
|
+
|
2722
|
+
# High
|
2723
|
+
HIGH =
|
2724
|
+
T.let(
|
2725
|
+
:high,
|
2726
|
+
Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
|
2727
|
+
)
|
2728
|
+
|
2729
|
+
sig do
|
2730
|
+
override.returns(
|
2731
|
+
T::Array[
|
2732
|
+
Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
|
2733
|
+
]
|
2734
|
+
)
|
2735
|
+
end
|
2736
|
+
def self.values
|
2737
|
+
end
|
2738
|
+
end
|
2739
|
+
end
|
2740
|
+
|
2633
2741
|
class SupplementalDocument < Increase::Internal::Type::BaseModel
|
2634
2742
|
OrHash =
|
2635
2743
|
T.type_alias do
|
@@ -0,0 +1,261 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Increase
|
4
|
+
module Models
|
5
|
+
class EntityUpdateParams < Increase::Internal::Type::BaseModel
|
6
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
7
|
+
include Increase::Internal::Type::RequestParameters
|
8
|
+
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(Increase::EntityUpdateParams, Increase::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
14
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
15
|
+
# such as money laundering.
|
16
|
+
sig { returns(T.nilable(Increase::EntityUpdateParams::RiskRating)) }
|
17
|
+
attr_reader :risk_rating
|
18
|
+
|
19
|
+
sig do
|
20
|
+
params(
|
21
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash
|
22
|
+
).void
|
23
|
+
end
|
24
|
+
attr_writer :risk_rating
|
25
|
+
|
26
|
+
# A reference to data stored in a third-party verification service. Your
|
27
|
+
# integration may or may not use this field.
|
28
|
+
sig do
|
29
|
+
returns(T.nilable(Increase::EntityUpdateParams::ThirdPartyVerification))
|
30
|
+
end
|
31
|
+
attr_reader :third_party_verification
|
32
|
+
|
33
|
+
sig do
|
34
|
+
params(
|
35
|
+
third_party_verification:
|
36
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::OrHash
|
37
|
+
).void
|
38
|
+
end
|
39
|
+
attr_writer :third_party_verification
|
40
|
+
|
41
|
+
sig do
|
42
|
+
params(
|
43
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
|
44
|
+
third_party_verification:
|
45
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::OrHash,
|
46
|
+
request_options: Increase::RequestOptions::OrHash
|
47
|
+
).returns(T.attached_class)
|
48
|
+
end
|
49
|
+
def self.new(
|
50
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
51
|
+
# such as money laundering.
|
52
|
+
risk_rating: nil,
|
53
|
+
# A reference to data stored in a third-party verification service. Your
|
54
|
+
# integration may or may not use this field.
|
55
|
+
third_party_verification: nil,
|
56
|
+
request_options: {}
|
57
|
+
)
|
58
|
+
end
|
59
|
+
|
60
|
+
sig do
|
61
|
+
override.returns(
|
62
|
+
{
|
63
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating,
|
64
|
+
third_party_verification:
|
65
|
+
Increase::EntityUpdateParams::ThirdPartyVerification,
|
66
|
+
request_options: Increase::RequestOptions
|
67
|
+
}
|
68
|
+
)
|
69
|
+
end
|
70
|
+
def to_hash
|
71
|
+
end
|
72
|
+
|
73
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
74
|
+
OrHash =
|
75
|
+
T.type_alias do
|
76
|
+
T.any(
|
77
|
+
Increase::EntityUpdateParams::RiskRating,
|
78
|
+
Increase::Internal::AnyHash
|
79
|
+
)
|
80
|
+
end
|
81
|
+
|
82
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
83
|
+
# rating was performed.
|
84
|
+
sig { returns(Time) }
|
85
|
+
attr_accessor :rated_at
|
86
|
+
|
87
|
+
# The rating given to this entity.
|
88
|
+
sig do
|
89
|
+
returns(Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol)
|
90
|
+
end
|
91
|
+
attr_accessor :rating
|
92
|
+
|
93
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
94
|
+
# such as money laundering.
|
95
|
+
sig do
|
96
|
+
params(
|
97
|
+
rated_at: Time,
|
98
|
+
rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
|
99
|
+
).returns(T.attached_class)
|
100
|
+
end
|
101
|
+
def self.new(
|
102
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
|
103
|
+
# rating was performed.
|
104
|
+
rated_at:,
|
105
|
+
# The rating given to this entity.
|
106
|
+
rating:
|
107
|
+
)
|
108
|
+
end
|
109
|
+
|
110
|
+
sig do
|
111
|
+
override.returns(
|
112
|
+
{
|
113
|
+
rated_at: Time,
|
114
|
+
rating: Increase::EntityUpdateParams::RiskRating::Rating::OrSymbol
|
115
|
+
}
|
116
|
+
)
|
117
|
+
end
|
118
|
+
def to_hash
|
119
|
+
end
|
120
|
+
|
121
|
+
# The rating given to this entity.
|
122
|
+
module Rating
|
123
|
+
extend Increase::Internal::Type::Enum
|
124
|
+
|
125
|
+
TaggedSymbol =
|
126
|
+
T.type_alias do
|
127
|
+
T.all(Symbol, Increase::EntityUpdateParams::RiskRating::Rating)
|
128
|
+
end
|
129
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
130
|
+
|
131
|
+
# Low
|
132
|
+
LOW =
|
133
|
+
T.let(
|
134
|
+
:low,
|
135
|
+
Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
|
136
|
+
)
|
137
|
+
|
138
|
+
# Medium
|
139
|
+
MEDIUM =
|
140
|
+
T.let(
|
141
|
+
:medium,
|
142
|
+
Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
|
143
|
+
)
|
144
|
+
|
145
|
+
# High
|
146
|
+
HIGH =
|
147
|
+
T.let(
|
148
|
+
:high,
|
149
|
+
Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
|
150
|
+
)
|
151
|
+
|
152
|
+
sig do
|
153
|
+
override.returns(
|
154
|
+
T::Array[
|
155
|
+
Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
|
156
|
+
]
|
157
|
+
)
|
158
|
+
end
|
159
|
+
def self.values
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
164
|
+
class ThirdPartyVerification < Increase::Internal::Type::BaseModel
|
165
|
+
OrHash =
|
166
|
+
T.type_alias do
|
167
|
+
T.any(
|
168
|
+
Increase::EntityUpdateParams::ThirdPartyVerification,
|
169
|
+
Increase::Internal::AnyHash
|
170
|
+
)
|
171
|
+
end
|
172
|
+
|
173
|
+
# The reference identifier for the third party verification.
|
174
|
+
sig { returns(String) }
|
175
|
+
attr_accessor :reference
|
176
|
+
|
177
|
+
# The vendor that was used to perform the verification.
|
178
|
+
sig do
|
179
|
+
returns(
|
180
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
|
181
|
+
)
|
182
|
+
end
|
183
|
+
attr_accessor :vendor
|
184
|
+
|
185
|
+
# A reference to data stored in a third-party verification service. Your
|
186
|
+
# integration may or may not use this field.
|
187
|
+
sig do
|
188
|
+
params(
|
189
|
+
reference: String,
|
190
|
+
vendor:
|
191
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
|
192
|
+
).returns(T.attached_class)
|
193
|
+
end
|
194
|
+
def self.new(
|
195
|
+
# The reference identifier for the third party verification.
|
196
|
+
reference:,
|
197
|
+
# The vendor that was used to perform the verification.
|
198
|
+
vendor:
|
199
|
+
)
|
200
|
+
end
|
201
|
+
|
202
|
+
sig do
|
203
|
+
override.returns(
|
204
|
+
{
|
205
|
+
reference: String,
|
206
|
+
vendor:
|
207
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::OrSymbol
|
208
|
+
}
|
209
|
+
)
|
210
|
+
end
|
211
|
+
def to_hash
|
212
|
+
end
|
213
|
+
|
214
|
+
# The vendor that was used to perform the verification.
|
215
|
+
module Vendor
|
216
|
+
extend Increase::Internal::Type::Enum
|
217
|
+
|
218
|
+
TaggedSymbol =
|
219
|
+
T.type_alias do
|
220
|
+
T.all(
|
221
|
+
Symbol,
|
222
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor
|
223
|
+
)
|
224
|
+
end
|
225
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
226
|
+
|
227
|
+
# Alloy. See https://alloy.com for more information.
|
228
|
+
ALLOY =
|
229
|
+
T.let(
|
230
|
+
:alloy,
|
231
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
|
232
|
+
)
|
233
|
+
|
234
|
+
# Middesk. See https://middesk.com for more information.
|
235
|
+
MIDDESK =
|
236
|
+
T.let(
|
237
|
+
:middesk,
|
238
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
|
239
|
+
)
|
240
|
+
|
241
|
+
# Oscilar. See https://oscilar.com for more information.
|
242
|
+
OSCILAR =
|
243
|
+
T.let(
|
244
|
+
:oscilar,
|
245
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
|
246
|
+
)
|
247
|
+
|
248
|
+
sig do
|
249
|
+
override.returns(
|
250
|
+
T::Array[
|
251
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::Vendor::TaggedSymbol
|
252
|
+
]
|
253
|
+
)
|
254
|
+
end
|
255
|
+
def self.values
|
256
|
+
end
|
257
|
+
end
|
258
|
+
end
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
data/rbi/increase/models.rbi
CHANGED
@@ -265,6 +265,8 @@ module Increase
|
|
265
265
|
EntityUpdateIndustryCodeParams =
|
266
266
|
Increase::Models::EntityUpdateIndustryCodeParams
|
267
267
|
|
268
|
+
EntityUpdateParams = Increase::Models::EntityUpdateParams
|
269
|
+
|
268
270
|
Event = Increase::Models::Event
|
269
271
|
|
270
272
|
EventListParams = Increase::Models::EventListParams
|
@@ -13,6 +13,7 @@ module Increase
|
|
13
13
|
Increase::EntityCreateParams::GovernmentAuthority::OrHash,
|
14
14
|
joint: Increase::EntityCreateParams::Joint::OrHash,
|
15
15
|
natural_person: Increase::EntityCreateParams::NaturalPerson::OrHash,
|
16
|
+
risk_rating: Increase::EntityCreateParams::RiskRating::OrHash,
|
16
17
|
supplemental_documents:
|
17
18
|
T::Array[
|
18
19
|
Increase::EntityCreateParams::SupplementalDocument::OrHash
|
@@ -42,6 +43,9 @@ module Increase
|
|
42
43
|
# `social_security_number` or `individual_taxpayer_identification_number`
|
43
44
|
# identification methods.
|
44
45
|
natural_person: nil,
|
46
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
47
|
+
# such as money laundering.
|
48
|
+
risk_rating: nil,
|
45
49
|
# Additional documentation associated with the entity.
|
46
50
|
supplemental_documents: nil,
|
47
51
|
# A reference to data stored in a third-party verification service. Your
|
@@ -68,6 +72,29 @@ module Increase
|
|
68
72
|
)
|
69
73
|
end
|
70
74
|
|
75
|
+
# Update an Entity
|
76
|
+
sig do
|
77
|
+
params(
|
78
|
+
entity_id: String,
|
79
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating::OrHash,
|
80
|
+
third_party_verification:
|
81
|
+
Increase::EntityUpdateParams::ThirdPartyVerification::OrHash,
|
82
|
+
request_options: Increase::RequestOptions::OrHash
|
83
|
+
).returns(Increase::Entity)
|
84
|
+
end
|
85
|
+
def update(
|
86
|
+
# The entity identifier.
|
87
|
+
entity_id,
|
88
|
+
# An assessment of the entity’s potential risk of involvement in financial crimes,
|
89
|
+
# such as money laundering.
|
90
|
+
risk_rating: nil,
|
91
|
+
# A reference to data stored in a third-party verification service. Your
|
92
|
+
# integration may or may not use this field.
|
93
|
+
third_party_verification: nil,
|
94
|
+
request_options: {}
|
95
|
+
)
|
96
|
+
end
|
97
|
+
|
71
98
|
# List Entities
|
72
99
|
sig do
|
73
100
|
params(
|
@@ -11,6 +11,7 @@ module Increase
|
|
11
11
|
idempotency_key: String?,
|
12
12
|
joint: Increase::Entity::Joint?,
|
13
13
|
natural_person: Increase::Entity::NaturalPerson?,
|
14
|
+
risk_rating: Increase::Entity::RiskRating?,
|
14
15
|
status: Increase::Models::Entity::status,
|
15
16
|
structure: Increase::Models::Entity::structure,
|
16
17
|
supplemental_documents: ::Array[Increase::EntitySupplementalDocument],
|
@@ -38,6 +39,8 @@ module Increase
|
|
38
39
|
|
39
40
|
attr_accessor natural_person: Increase::Entity::NaturalPerson?
|
40
41
|
|
42
|
+
attr_accessor risk_rating: Increase::Entity::RiskRating?
|
43
|
+
|
41
44
|
attr_accessor status: Increase::Models::Entity::status
|
42
45
|
|
43
46
|
attr_accessor structure: Increase::Models::Entity::structure
|
@@ -60,6 +63,7 @@ module Increase
|
|
60
63
|
idempotency_key: String?,
|
61
64
|
joint: Increase::Entity::Joint?,
|
62
65
|
natural_person: Increase::Entity::NaturalPerson?,
|
66
|
+
risk_rating: Increase::Entity::RiskRating?,
|
63
67
|
status: Increase::Models::Entity::status,
|
64
68
|
structure: Increase::Models::Entity::structure,
|
65
69
|
supplemental_documents: ::Array[Increase::EntitySupplementalDocument],
|
@@ -78,6 +82,7 @@ module Increase
|
|
78
82
|
idempotency_key: String?,
|
79
83
|
joint: Increase::Entity::Joint?,
|
80
84
|
natural_person: Increase::Entity::NaturalPerson?,
|
85
|
+
risk_rating: Increase::Entity::RiskRating?,
|
81
86
|
status: Increase::Models::Entity::status,
|
82
87
|
structure: Increase::Models::Entity::structure,
|
83
88
|
supplemental_documents: ::Array[Increase::EntitySupplementalDocument],
|
@@ -712,6 +717,42 @@ module Increase
|
|
712
717
|
end
|
713
718
|
end
|
714
719
|
|
720
|
+
type risk_rating =
|
721
|
+
{ rated_at: Time, rating: Increase::Models::Entity::RiskRating::rating }
|
722
|
+
|
723
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
724
|
+
attr_accessor rated_at: Time
|
725
|
+
|
726
|
+
attr_accessor rating: Increase::Models::Entity::RiskRating::rating
|
727
|
+
|
728
|
+
def initialize: (
|
729
|
+
rated_at: Time,
|
730
|
+
rating: Increase::Models::Entity::RiskRating::rating
|
731
|
+
) -> void
|
732
|
+
|
733
|
+
def to_hash: -> {
|
734
|
+
rated_at: Time,
|
735
|
+
rating: Increase::Models::Entity::RiskRating::rating
|
736
|
+
}
|
737
|
+
|
738
|
+
type rating = :low | :medium | :high
|
739
|
+
|
740
|
+
module Rating
|
741
|
+
extend Increase::Internal::Type::Enum
|
742
|
+
|
743
|
+
# Low
|
744
|
+
LOW: :low
|
745
|
+
|
746
|
+
# Medium
|
747
|
+
MEDIUM: :medium
|
748
|
+
|
749
|
+
# High
|
750
|
+
HIGH: :high
|
751
|
+
|
752
|
+
def self?.values: -> ::Array[Increase::Models::Entity::RiskRating::rating]
|
753
|
+
end
|
754
|
+
end
|
755
|
+
|
715
756
|
type status = :active | :archived | :disabled
|
716
757
|
|
717
758
|
module Status
|
@@ -8,6 +8,7 @@ module Increase
|
|
8
8
|
government_authority: Increase::EntityCreateParams::GovernmentAuthority,
|
9
9
|
joint: Increase::EntityCreateParams::Joint,
|
10
10
|
natural_person: Increase::EntityCreateParams::NaturalPerson,
|
11
|
+
risk_rating: Increase::EntityCreateParams::RiskRating,
|
11
12
|
supplemental_documents: ::Array[Increase::EntityCreateParams::SupplementalDocument],
|
12
13
|
third_party_verification: Increase::EntityCreateParams::ThirdPartyVerification,
|
13
14
|
trust: Increase::EntityCreateParams::Trust
|
@@ -48,6 +49,12 @@ module Increase
|
|
48
49
|
Increase::EntityCreateParams::NaturalPerson
|
49
50
|
) -> Increase::EntityCreateParams::NaturalPerson
|
50
51
|
|
52
|
+
attr_reader risk_rating: Increase::EntityCreateParams::RiskRating?
|
53
|
+
|
54
|
+
def risk_rating=: (
|
55
|
+
Increase::EntityCreateParams::RiskRating
|
56
|
+
) -> Increase::EntityCreateParams::RiskRating
|
57
|
+
|
51
58
|
attr_reader supplemental_documents: ::Array[Increase::EntityCreateParams::SupplementalDocument]?
|
52
59
|
|
53
60
|
def supplemental_documents=: (
|
@@ -73,6 +80,7 @@ module Increase
|
|
73
80
|
?government_authority: Increase::EntityCreateParams::GovernmentAuthority,
|
74
81
|
?joint: Increase::EntityCreateParams::Joint,
|
75
82
|
?natural_person: Increase::EntityCreateParams::NaturalPerson,
|
83
|
+
?risk_rating: Increase::EntityCreateParams::RiskRating,
|
76
84
|
?supplemental_documents: ::Array[Increase::EntityCreateParams::SupplementalDocument],
|
77
85
|
?third_party_verification: Increase::EntityCreateParams::ThirdPartyVerification,
|
78
86
|
?trust: Increase::EntityCreateParams::Trust,
|
@@ -86,6 +94,7 @@ module Increase
|
|
86
94
|
government_authority: Increase::EntityCreateParams::GovernmentAuthority,
|
87
95
|
joint: Increase::EntityCreateParams::Joint,
|
88
96
|
natural_person: Increase::EntityCreateParams::NaturalPerson,
|
97
|
+
risk_rating: Increase::EntityCreateParams::RiskRating,
|
89
98
|
supplemental_documents: ::Array[Increase::EntityCreateParams::SupplementalDocument],
|
90
99
|
third_party_verification: Increase::EntityCreateParams::ThirdPartyVerification,
|
91
100
|
trust: Increase::EntityCreateParams::Trust,
|
@@ -1179,6 +1188,45 @@ module Increase
|
|
1179
1188
|
end
|
1180
1189
|
end
|
1181
1190
|
|
1191
|
+
type risk_rating =
|
1192
|
+
{
|
1193
|
+
rated_at: Time,
|
1194
|
+
rating: Increase::Models::EntityCreateParams::RiskRating::rating
|
1195
|
+
}
|
1196
|
+
|
1197
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
1198
|
+
attr_accessor rated_at: Time
|
1199
|
+
|
1200
|
+
attr_accessor rating: Increase::Models::EntityCreateParams::RiskRating::rating
|
1201
|
+
|
1202
|
+
def initialize: (
|
1203
|
+
rated_at: Time,
|
1204
|
+
rating: Increase::Models::EntityCreateParams::RiskRating::rating
|
1205
|
+
) -> void
|
1206
|
+
|
1207
|
+
def to_hash: -> {
|
1208
|
+
rated_at: Time,
|
1209
|
+
rating: Increase::Models::EntityCreateParams::RiskRating::rating
|
1210
|
+
}
|
1211
|
+
|
1212
|
+
type rating = :low | :medium | :high
|
1213
|
+
|
1214
|
+
module Rating
|
1215
|
+
extend Increase::Internal::Type::Enum
|
1216
|
+
|
1217
|
+
# Low
|
1218
|
+
LOW: :low
|
1219
|
+
|
1220
|
+
# Medium
|
1221
|
+
MEDIUM: :medium
|
1222
|
+
|
1223
|
+
# High
|
1224
|
+
HIGH: :high
|
1225
|
+
|
1226
|
+
def self?.values: -> ::Array[Increase::Models::EntityCreateParams::RiskRating::rating]
|
1227
|
+
end
|
1228
|
+
end
|
1229
|
+
|
1182
1230
|
type supplemental_document = { file_id: String }
|
1183
1231
|
|
1184
1232
|
class SupplementalDocument < Increase::Internal::Type::BaseModel
|
@@ -0,0 +1,117 @@
|
|
1
|
+
module Increase
|
2
|
+
module Models
|
3
|
+
type entity_update_params =
|
4
|
+
{
|
5
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating,
|
6
|
+
third_party_verification: Increase::EntityUpdateParams::ThirdPartyVerification
|
7
|
+
}
|
8
|
+
& Increase::Internal::Type::request_parameters
|
9
|
+
|
10
|
+
class EntityUpdateParams < Increase::Internal::Type::BaseModel
|
11
|
+
extend Increase::Internal::Type::RequestParameters::Converter
|
12
|
+
include Increase::Internal::Type::RequestParameters
|
13
|
+
|
14
|
+
attr_reader risk_rating: Increase::EntityUpdateParams::RiskRating?
|
15
|
+
|
16
|
+
def risk_rating=: (
|
17
|
+
Increase::EntityUpdateParams::RiskRating
|
18
|
+
) -> Increase::EntityUpdateParams::RiskRating
|
19
|
+
|
20
|
+
attr_reader third_party_verification: Increase::EntityUpdateParams::ThirdPartyVerification?
|
21
|
+
|
22
|
+
def third_party_verification=: (
|
23
|
+
Increase::EntityUpdateParams::ThirdPartyVerification
|
24
|
+
) -> Increase::EntityUpdateParams::ThirdPartyVerification
|
25
|
+
|
26
|
+
def initialize: (
|
27
|
+
?risk_rating: Increase::EntityUpdateParams::RiskRating,
|
28
|
+
?third_party_verification: Increase::EntityUpdateParams::ThirdPartyVerification,
|
29
|
+
?request_options: Increase::request_opts
|
30
|
+
) -> void
|
31
|
+
|
32
|
+
def to_hash: -> {
|
33
|
+
risk_rating: Increase::EntityUpdateParams::RiskRating,
|
34
|
+
third_party_verification: Increase::EntityUpdateParams::ThirdPartyVerification,
|
35
|
+
request_options: Increase::RequestOptions
|
36
|
+
}
|
37
|
+
|
38
|
+
type risk_rating =
|
39
|
+
{
|
40
|
+
rated_at: Time,
|
41
|
+
rating: Increase::Models::EntityUpdateParams::RiskRating::rating
|
42
|
+
}
|
43
|
+
|
44
|
+
class RiskRating < Increase::Internal::Type::BaseModel
|
45
|
+
attr_accessor rated_at: Time
|
46
|
+
|
47
|
+
attr_accessor rating: Increase::Models::EntityUpdateParams::RiskRating::rating
|
48
|
+
|
49
|
+
def initialize: (
|
50
|
+
rated_at: Time,
|
51
|
+
rating: Increase::Models::EntityUpdateParams::RiskRating::rating
|
52
|
+
) -> void
|
53
|
+
|
54
|
+
def to_hash: -> {
|
55
|
+
rated_at: Time,
|
56
|
+
rating: Increase::Models::EntityUpdateParams::RiskRating::rating
|
57
|
+
}
|
58
|
+
|
59
|
+
type rating = :low | :medium | :high
|
60
|
+
|
61
|
+
module Rating
|
62
|
+
extend Increase::Internal::Type::Enum
|
63
|
+
|
64
|
+
# Low
|
65
|
+
LOW: :low
|
66
|
+
|
67
|
+
# Medium
|
68
|
+
MEDIUM: :medium
|
69
|
+
|
70
|
+
# High
|
71
|
+
HIGH: :high
|
72
|
+
|
73
|
+
def self?.values: -> ::Array[Increase::Models::EntityUpdateParams::RiskRating::rating]
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
type third_party_verification =
|
78
|
+
{
|
79
|
+
reference: String,
|
80
|
+
vendor: Increase::Models::EntityUpdateParams::ThirdPartyVerification::vendor
|
81
|
+
}
|
82
|
+
|
83
|
+
class ThirdPartyVerification < Increase::Internal::Type::BaseModel
|
84
|
+
attr_accessor reference: String
|
85
|
+
|
86
|
+
attr_accessor vendor: Increase::Models::EntityUpdateParams::ThirdPartyVerification::vendor
|
87
|
+
|
88
|
+
def initialize: (
|
89
|
+
reference: String,
|
90
|
+
vendor: Increase::Models::EntityUpdateParams::ThirdPartyVerification::vendor
|
91
|
+
) -> void
|
92
|
+
|
93
|
+
def to_hash: -> {
|
94
|
+
reference: String,
|
95
|
+
vendor: Increase::Models::EntityUpdateParams::ThirdPartyVerification::vendor
|
96
|
+
}
|
97
|
+
|
98
|
+
type vendor = :alloy | :middesk | :oscilar
|
99
|
+
|
100
|
+
module Vendor
|
101
|
+
extend Increase::Internal::Type::Enum
|
102
|
+
|
103
|
+
# Alloy. See https://alloy.com for more information.
|
104
|
+
ALLOY: :alloy
|
105
|
+
|
106
|
+
# Middesk. See https://middesk.com for more information.
|
107
|
+
MIDDESK: :middesk
|
108
|
+
|
109
|
+
# Oscilar. See https://oscilar.com for more information.
|
110
|
+
OSCILAR: :oscilar
|
111
|
+
|
112
|
+
def self?.values: -> ::Array[Increase::Models::EntityUpdateParams::ThirdPartyVerification::vendor]
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
data/sig/increase/models.rbs
CHANGED
@@ -235,6 +235,8 @@ module Increase
|
|
235
235
|
|
236
236
|
class EntityUpdateIndustryCodeParams = Increase::Models::EntityUpdateIndustryCodeParams
|
237
237
|
|
238
|
+
class EntityUpdateParams = Increase::Models::EntityUpdateParams
|
239
|
+
|
238
240
|
class Event = Increase::Models::Event
|
239
241
|
|
240
242
|
class EventListParams = Increase::Models::EventListParams
|
@@ -8,6 +8,7 @@ module Increase
|
|
8
8
|
?government_authority: Increase::EntityCreateParams::GovernmentAuthority,
|
9
9
|
?joint: Increase::EntityCreateParams::Joint,
|
10
10
|
?natural_person: Increase::EntityCreateParams::NaturalPerson,
|
11
|
+
?risk_rating: Increase::EntityCreateParams::RiskRating,
|
11
12
|
?supplemental_documents: ::Array[Increase::EntityCreateParams::SupplementalDocument],
|
12
13
|
?third_party_verification: Increase::EntityCreateParams::ThirdPartyVerification,
|
13
14
|
?trust: Increase::EntityCreateParams::Trust,
|
@@ -19,6 +20,13 @@ module Increase
|
|
19
20
|
?request_options: Increase::request_opts
|
20
21
|
) -> Increase::Entity
|
21
22
|
|
23
|
+
def update: (
|
24
|
+
String entity_id,
|
25
|
+
?risk_rating: Increase::EntityUpdateParams::RiskRating,
|
26
|
+
?third_party_verification: Increase::EntityUpdateParams::ThirdPartyVerification,
|
27
|
+
?request_options: Increase::request_opts
|
28
|
+
) -> Increase::Entity
|
29
|
+
|
22
30
|
def list: (
|
23
31
|
?created_at: Increase::EntityListParams::CreatedAt,
|
24
32
|
?cursor: String,
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: increase
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.64.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Increase
|
@@ -174,6 +174,7 @@ files:
|
|
174
174
|
- lib/increase/models/entity_update_address_params.rb
|
175
175
|
- lib/increase/models/entity_update_beneficial_owner_address_params.rb
|
176
176
|
- lib/increase/models/entity_update_industry_code_params.rb
|
177
|
+
- lib/increase/models/entity_update_params.rb
|
177
178
|
- lib/increase/models/event.rb
|
178
179
|
- lib/increase/models/event_list_params.rb
|
179
180
|
- lib/increase/models/event_retrieve_params.rb
|
@@ -558,6 +559,7 @@ files:
|
|
558
559
|
- rbi/increase/models/entity_update_address_params.rbi
|
559
560
|
- rbi/increase/models/entity_update_beneficial_owner_address_params.rbi
|
560
561
|
- rbi/increase/models/entity_update_industry_code_params.rbi
|
562
|
+
- rbi/increase/models/entity_update_params.rbi
|
561
563
|
- rbi/increase/models/event.rbi
|
562
564
|
- rbi/increase/models/event_list_params.rbi
|
563
565
|
- rbi/increase/models/event_retrieve_params.rbi
|
@@ -941,6 +943,7 @@ files:
|
|
941
943
|
- sig/increase/models/entity_update_address_params.rbs
|
942
944
|
- sig/increase/models/entity_update_beneficial_owner_address_params.rbs
|
943
945
|
- sig/increase/models/entity_update_industry_code_params.rbs
|
946
|
+
- sig/increase/models/entity_update_params.rbs
|
944
947
|
- sig/increase/models/event.rbs
|
945
948
|
- sig/increase/models/event_list_params.rbs
|
946
949
|
- sig/increase/models/event_retrieve_params.rbs
|