increase 1.70.0 → 1.72.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: 9cd88adf310b4dd4346e9bf0bdabf14bb2c34a93c58cd3bba4ba79f09263c65a
4
- data.tar.gz: d4c7ad4a986b1cebff6635685f844ddb5673c7acb5479a22d674272960264fbc
3
+ metadata.gz: e6573c64ef6d55746a7b5f74d2ae538cdd1ac3c3e2de191a59d14ebaabcd2b9a
4
+ data.tar.gz: bfaa07b7d6e8a0c917a05c82872aecb695d290880f7dedf5a0e429d3f9e81f48
5
5
  SHA512:
6
- metadata.gz: d5eed4a74229d448e4fbae64a68f5a28cf3914b878ff302f7715c5dd474f35cfef11ad7bd6327f88d39a88ae5d510cd80edf06a3da45c0ea9a5f59fcf10fca9a
7
- data.tar.gz: 61d60d64e2c7f41750ccdee4dccbcce4a45e66129c8ff178b9eb5ec606b813385f17989b83529f33ae70f10056422bce5d86e17309dec314b8d0258e09e1eabb
6
+ metadata.gz: cbe4e5e4d1bedb485d13a909ed90fd0ea6122e277b883d63a822d219e468bc52ae222580541d47f1f5feb95805e67b0c819c1ccb0c886cbc453a7cde6fa07adc
7
+ data.tar.gz: 014efd8432f6b10e53b0553d786ded92b90704078541b118d1d275ebdce24e4b71c3e6d7a3cabb54f73c161f1d236ebfa76347a6dd3452de553875764be956b0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.72.0 (2025-09-08)
4
+
5
+ Full Changelog: [v1.71.0...v1.72.0](https://github.com/Increase/increase-ruby/compare/v1.71.0...v1.72.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([a403346](https://github.com/Increase/increase-ruby/commit/a4033467d8e63b6a28308ee936f44052c26ad6a1))
10
+
11
+ ## 1.71.0 (2025-09-08)
12
+
13
+ Full Changelog: [v1.70.0...v1.71.0](https://github.com/Increase/increase-ruby/compare/v1.70.0...v1.71.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** api update ([7c069c1](https://github.com/Increase/increase-ruby/commit/7c069c1f6567eb6eb38eafbc9baafe454d621dea))
18
+
3
19
  ## 1.70.0 (2025-09-08)
4
20
 
5
21
  Full Changelog: [v1.69.0...v1.70.0](https://github.com/Increase/increase-ruby/compare/v1.69.0...v1.70.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.70.0"
18
+ gem "increase", "~> 1.72.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -94,8 +94,9 @@ module Increase
94
94
  -> { Increase::Internal::Type::ArrayOf[Increase::EntitySupplementalDocument] }
95
95
 
96
96
  # @!attribute third_party_verification
97
- # A reference to data stored in a third-party verification service. Your
98
- # integration may or may not use this field.
97
+ # If you are using a third-party service for identity verification, you can use
98
+ # this field to associate this Entity with the identifier that represents them in
99
+ # that service.
99
100
  #
100
101
  # @return [Increase::Models::Entity::ThirdPartyVerification, nil]
101
102
  required :third_party_verification, -> { Increase::Entity::ThirdPartyVerification }, nil?: true
@@ -146,7 +147,7 @@ module Increase
146
147
  #
147
148
  # @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>] Additional documentation associated with the entity. This is limited to the firs
148
149
  #
149
- # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] A reference to data stored in a third-party verification service. Your integrati
150
+ # @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] If you are using a third-party service for identity verification, you can use th
150
151
  #
151
152
  # @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
152
153
  #
@@ -960,13 +961,13 @@ module Increase
960
961
  module Rating
961
962
  extend Increase::Internal::Type::Enum
962
963
 
963
- # Low
964
+ # Minimal risk of involvement in financial crime.
964
965
  LOW = :low
965
966
 
966
- # Medium
967
+ # Moderate risk of involvement in financial crime.
967
968
  MEDIUM = :medium
968
969
 
969
- # High
970
+ # Elevated risk of involvement in financial crime.
970
971
  HIGH = :high
971
972
 
972
973
  # @!method self.values
@@ -1033,8 +1034,9 @@ module Increase
1033
1034
  required :vendor, enum: -> { Increase::Entity::ThirdPartyVerification::Vendor }
1034
1035
 
1035
1036
  # @!method initialize(reference:, vendor:)
1036
- # A reference to data stored in a third-party verification service. Your
1037
- # integration may or may not use this field.
1037
+ # If you are using a third-party service for identity verification, you can use
1038
+ # this field to associate this Entity with the identifier that represents them in
1039
+ # that service.
1038
1040
  #
1039
1041
  # @param reference [String] The reference identifier for the third party verification.
1040
1042
  #
@@ -64,8 +64,9 @@ module Increase
64
64
  -> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::SupplementalDocument] }
65
65
 
66
66
  # @!attribute third_party_verification
67
- # A reference to data stored in a third-party verification service. Your
68
- # integration may or may not use this field.
67
+ # If you are using a third-party service for identity verification, you can use
68
+ # this field to associate this Entity with the identifier that represents them in
69
+ # that service.
69
70
  #
70
71
  # @return [Increase::Models::EntityCreateParams::ThirdPartyVerification, nil]
71
72
  optional :third_party_verification, -> { Increase::EntityCreateParams::ThirdPartyVerification }
@@ -97,7 +98,7 @@ module Increase
97
98
  #
98
99
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
99
100
  #
100
- # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
101
+ # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
101
102
  #
102
103
  # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
103
104
  #
@@ -1476,13 +1477,13 @@ module Increase
1476
1477
  module Rating
1477
1478
  extend Increase::Internal::Type::Enum
1478
1479
 
1479
- # Low
1480
+ # Minimal risk of involvement in financial crime.
1480
1481
  LOW = :low
1481
1482
 
1482
- # Medium
1483
+ # Moderate risk of involvement in financial crime.
1483
1484
  MEDIUM = :medium
1484
1485
 
1485
- # High
1486
+ # Elevated risk of involvement in financial crime.
1486
1487
  HIGH = :high
1487
1488
 
1488
1489
  # @!method self.values
@@ -1515,8 +1516,9 @@ module Increase
1515
1516
  required :vendor, enum: -> { Increase::EntityCreateParams::ThirdPartyVerification::Vendor }
1516
1517
 
1517
1518
  # @!method initialize(reference:, vendor:)
1518
- # A reference to data stored in a third-party verification service. Your
1519
- # integration may or may not use this field.
1519
+ # If you are using a third-party service for identity verification, you can use
1520
+ # this field to associate this Entity with the identifier that represents them in
1521
+ # that service.
1520
1522
  #
1521
1523
  # @param reference [String] The reference identifier for the third party verification.
1522
1524
  #
@@ -14,6 +14,14 @@ module Increase
14
14
  # @return [Increase::Models::EntityUpdateParams::Corporation, nil]
15
15
  optional :corporation, -> { Increase::EntityUpdateParams::Corporation }
16
16
 
17
+ # @!attribute details_confirmed_at
18
+ # When your user last confirmed the Entity's details. Depending on your program,
19
+ # you may be required to affirmatively confirm details with your users on an
20
+ # annual basis.
21
+ #
22
+ # @return [Time, nil]
23
+ optional :details_confirmed_at, Time
24
+
17
25
  # @!attribute government_authority
18
26
  # Details of the government authority entity to update. If you specify this
19
27
  # parameter and the entity is not a government authority, the request will fail.
@@ -36,8 +44,9 @@ module Increase
36
44
  optional :risk_rating, -> { Increase::EntityUpdateParams::RiskRating }
37
45
 
38
46
  # @!attribute third_party_verification
39
- # A reference to data stored in a third-party verification service. Your
40
- # integration may or may not use this field.
47
+ # If you are using a third-party service for identity verification, you can use
48
+ # this field to associate this Entity with the identifier that represents them in
49
+ # that service.
41
50
  #
42
51
  # @return [Increase::Models::EntityUpdateParams::ThirdPartyVerification, nil]
43
52
  optional :third_party_verification, -> { Increase::EntityUpdateParams::ThirdPartyVerification }
@@ -49,19 +58,21 @@ module Increase
49
58
  # @return [Increase::Models::EntityUpdateParams::Trust, nil]
50
59
  optional :trust, -> { Increase::EntityUpdateParams::Trust }
51
60
 
52
- # @!method initialize(corporation: nil, government_authority: nil, natural_person: nil, risk_rating: nil, third_party_verification: nil, trust: nil, request_options: {})
61
+ # @!method initialize(corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, third_party_verification: nil, trust: nil, request_options: {})
53
62
  # Some parameter documentations has been truncated, see
54
63
  # {Increase::Models::EntityUpdateParams} for more details.
55
64
  #
56
65
  # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update. If you specify this parameter and t
57
66
  #
67
+ # @param details_confirmed_at [Time] When your user last confirmed the Entity's details. Depending on your program, y
68
+ #
58
69
  # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update. If you specify this parame
59
70
  #
60
71
  # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update. If you specify this parameter an
61
72
  #
62
73
  # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
63
74
  #
64
- # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
75
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
65
76
  #
66
77
  # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
67
78
  #
@@ -341,13 +352,13 @@ module Increase
341
352
  module Rating
342
353
  extend Increase::Internal::Type::Enum
343
354
 
344
- # Low
355
+ # Minimal risk of involvement in financial crime.
345
356
  LOW = :low
346
357
 
347
- # Medium
358
+ # Moderate risk of involvement in financial crime.
348
359
  MEDIUM = :medium
349
360
 
350
- # High
361
+ # Elevated risk of involvement in financial crime.
351
362
  HIGH = :high
352
363
 
353
364
  # @!method self.values
@@ -369,8 +380,9 @@ module Increase
369
380
  required :vendor, enum: -> { Increase::EntityUpdateParams::ThirdPartyVerification::Vendor }
370
381
 
371
382
  # @!method initialize(reference:, vendor:)
372
- # A reference to data stored in a third-party verification service. Your
373
- # integration may or may not use this field.
383
+ # If you are using a third-party service for identity verification, you can use
384
+ # this field to associate this Entity with the identifier that represents them in
385
+ # that service.
374
386
  #
375
387
  # @param reference [String] The reference identifier for the third party verification.
376
388
  #
@@ -26,7 +26,7 @@ module Increase
26
26
  #
27
27
  # @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
28
28
  #
29
- # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
29
+ # @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
30
30
  #
31
31
  # @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
32
32
  #
@@ -71,19 +71,21 @@ module Increase
71
71
  #
72
72
  # Update an Entity
73
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: {})
74
+ # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, third_party_verification: nil, trust: nil, request_options: {})
75
75
  #
76
76
  # @param entity_id [String] The entity identifier.
77
77
  #
78
78
  # @param corporation [Increase::Models::EntityUpdateParams::Corporation] Details of the corporation entity to update. If you specify this parameter and t
79
79
  #
80
+ # @param details_confirmed_at [Time] When your user last confirmed the Entity's details. Depending on your program, y
81
+ #
80
82
  # @param government_authority [Increase::Models::EntityUpdateParams::GovernmentAuthority] Details of the government authority entity to update. If you specify this parame
81
83
  #
82
84
  # @param natural_person [Increase::Models::EntityUpdateParams::NaturalPerson] Details of the natural person entity to update. If you specify this parameter an
83
85
  #
84
86
  # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating] An assessment of the entity’s potential risk of involvement in financial crimes,
85
87
  #
86
- # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] A reference to data stored in a third-party verification service. Your integrati
88
+ # @param third_party_verification [Increase::Models::EntityUpdateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
87
89
  #
88
90
  # @param trust [Increase::Models::EntityUpdateParams::Trust] Details of the trust entity to update. If you specify this parameter and the ent
89
91
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Increase
4
- VERSION = "1.70.0"
4
+ VERSION = "1.72.0"
5
5
  end
@@ -100,8 +100,9 @@ module Increase
100
100
  sig { returns(T::Array[Increase::EntitySupplementalDocument]) }
101
101
  attr_accessor :supplemental_documents
102
102
 
103
- # A reference to data stored in a third-party verification service. Your
104
- # integration may or may not use this field.
103
+ # If you are using a third-party service for identity verification, you can use
104
+ # this field to associate this Entity with the identifier that represents them in
105
+ # that service.
105
106
  sig { returns(T.nilable(Increase::Entity::ThirdPartyVerification)) }
106
107
  attr_reader :third_party_verification
107
108
 
@@ -187,8 +188,9 @@ module Increase
187
188
  # first 10 documents for an entity. If an entity has more than 10 documents, use
188
189
  # the GET /entity_supplemental_documents list endpoint to retrieve them.
189
190
  supplemental_documents:,
190
- # A reference to data stored in a third-party verification service. Your
191
- # integration may or may not use this field.
191
+ # If you are using a third-party service for identity verification, you can use
192
+ # this field to associate this Entity with the identifier that represents them in
193
+ # that service.
192
194
  third_party_verification:,
193
195
  # Details of the trust entity. Will be present if `structure` is equal to `trust`.
194
196
  trust:,
@@ -1640,14 +1642,14 @@ module Increase
1640
1642
  T.type_alias { T.all(Symbol, Increase::Entity::RiskRating::Rating) }
1641
1643
  OrSymbol = T.type_alias { T.any(Symbol, String) }
1642
1644
 
1643
- # Low
1645
+ # Minimal risk of involvement in financial crime.
1644
1646
  LOW = T.let(:low, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1645
1647
 
1646
- # Medium
1648
+ # Moderate risk of involvement in financial crime.
1647
1649
  MEDIUM =
1648
1650
  T.let(:medium, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1649
1651
 
1650
- # High
1652
+ # Elevated risk of involvement in financial crime.
1651
1653
  HIGH =
1652
1654
  T.let(:high, Increase::Entity::RiskRating::Rating::TaggedSymbol)
1653
1655
 
@@ -1741,8 +1743,9 @@ module Increase
1741
1743
  end
1742
1744
  attr_accessor :vendor
1743
1745
 
1744
- # A reference to data stored in a third-party verification service. Your
1745
- # integration may or may not use this field.
1746
+ # If you are using a third-party service for identity verification, you can use
1747
+ # this field to associate this Entity with the identifier that represents them in
1748
+ # that service.
1746
1749
  sig do
1747
1750
  params(
1748
1751
  reference: String,
@@ -101,8 +101,9 @@ module Increase
101
101
  end
102
102
  attr_writer :supplemental_documents
103
103
 
104
- # A reference to data stored in a third-party verification service. Your
105
- # integration may or may not use this field.
104
+ # If you are using a third-party service for identity verification, you can use
105
+ # this field to associate this Entity with the identifier that represents them in
106
+ # that service.
106
107
  sig do
107
108
  returns(T.nilable(Increase::EntityCreateParams::ThirdPartyVerification))
108
109
  end
@@ -168,8 +169,9 @@ module Increase
168
169
  risk_rating: nil,
169
170
  # Additional documentation associated with the entity.
170
171
  supplemental_documents: nil,
171
- # A reference to data stored in a third-party verification service. Your
172
- # integration may or may not use this field.
172
+ # If you are using a third-party service for identity verification, you can use
173
+ # this field to associate this Entity with the identifier that represents them in
174
+ # that service.
173
175
  third_party_verification: nil,
174
176
  # Details of the trust entity to create. Required if `structure` is equal to
175
177
  # `trust`.
@@ -2705,21 +2707,21 @@ module Increase
2705
2707
  end
2706
2708
  OrSymbol = T.type_alias { T.any(Symbol, String) }
2707
2709
 
2708
- # Low
2710
+ # Minimal risk of involvement in financial crime.
2709
2711
  LOW =
2710
2712
  T.let(
2711
2713
  :low,
2712
2714
  Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
2713
2715
  )
2714
2716
 
2715
- # Medium
2717
+ # Moderate risk of involvement in financial crime.
2716
2718
  MEDIUM =
2717
2719
  T.let(
2718
2720
  :medium,
2719
2721
  Increase::EntityCreateParams::RiskRating::Rating::TaggedSymbol
2720
2722
  )
2721
2723
 
2722
- # High
2724
+ # Elevated risk of involvement in financial crime.
2723
2725
  HIGH =
2724
2726
  T.let(
2725
2727
  :high,
@@ -2784,8 +2786,9 @@ module Increase
2784
2786
  end
2785
2787
  attr_accessor :vendor
2786
2788
 
2787
- # A reference to data stored in a third-party verification service. Your
2788
- # integration may or may not use this field.
2789
+ # If you are using a third-party service for identity verification, you can use
2790
+ # this field to associate this Entity with the identifier that represents them in
2791
+ # that service.
2789
2792
  sig do
2790
2793
  params(
2791
2794
  reference: String,
@@ -23,6 +23,15 @@ module Increase
23
23
  end
24
24
  attr_writer :corporation
25
25
 
26
+ # When your user last confirmed the Entity's details. Depending on your program,
27
+ # you may be required to affirmatively confirm details with your users on an
28
+ # annual basis.
29
+ sig { returns(T.nilable(Time)) }
30
+ attr_reader :details_confirmed_at
31
+
32
+ sig { params(details_confirmed_at: Time).void }
33
+ attr_writer :details_confirmed_at
34
+
26
35
  # Details of the government authority entity to update. If you specify this
27
36
  # parameter and the entity is not a government authority, the request will fail.
28
37
  sig do
@@ -62,8 +71,9 @@ module Increase
62
71
  end
63
72
  attr_writer :risk_rating
64
73
 
65
- # A reference to data stored in a third-party verification service. Your
66
- # integration may or may not use this field.
74
+ # If you are using a third-party service for identity verification, you can use
75
+ # this field to associate this Entity with the identifier that represents them in
76
+ # that service.
67
77
  sig do
68
78
  returns(T.nilable(Increase::EntityUpdateParams::ThirdPartyVerification))
69
79
  end
@@ -88,6 +98,7 @@ module Increase
88
98
  sig do
89
99
  params(
90
100
  corporation: Increase::EntityUpdateParams::Corporation::OrHash,
101
+ details_confirmed_at: Time,
91
102
  government_authority:
92
103
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
93
104
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
@@ -102,6 +113,10 @@ module Increase
102
113
  # Details of the corporation entity to update. If you specify this parameter and
103
114
  # the entity is not a corporation, the request will fail.
104
115
  corporation: nil,
116
+ # When your user last confirmed the Entity's details. Depending on your program,
117
+ # you may be required to affirmatively confirm details with your users on an
118
+ # annual basis.
119
+ details_confirmed_at: nil,
105
120
  # Details of the government authority entity to update. If you specify this
106
121
  # parameter and the entity is not a government authority, the request will fail.
107
122
  government_authority: nil,
@@ -111,8 +126,9 @@ module Increase
111
126
  # An assessment of the entity’s potential risk of involvement in financial crimes,
112
127
  # such as money laundering.
113
128
  risk_rating: nil,
114
- # A reference to data stored in a third-party verification service. Your
115
- # integration may or may not use this field.
129
+ # If you are using a third-party service for identity verification, you can use
130
+ # this field to associate this Entity with the identifier that represents them in
131
+ # that service.
116
132
  third_party_verification: nil,
117
133
  # Details of the trust entity to update. If you specify this parameter and the
118
134
  # entity is not a trust, the request will fail.
@@ -125,6 +141,7 @@ module Increase
125
141
  override.returns(
126
142
  {
127
143
  corporation: Increase::EntityUpdateParams::Corporation,
144
+ details_confirmed_at: Time,
128
145
  government_authority:
129
146
  Increase::EntityUpdateParams::GovernmentAuthority,
130
147
  natural_person: Increase::EntityUpdateParams::NaturalPerson,
@@ -624,21 +641,21 @@ module Increase
624
641
  end
625
642
  OrSymbol = T.type_alias { T.any(Symbol, String) }
626
643
 
627
- # Low
644
+ # Minimal risk of involvement in financial crime.
628
645
  LOW =
629
646
  T.let(
630
647
  :low,
631
648
  Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
632
649
  )
633
650
 
634
- # Medium
651
+ # Moderate risk of involvement in financial crime.
635
652
  MEDIUM =
636
653
  T.let(
637
654
  :medium,
638
655
  Increase::EntityUpdateParams::RiskRating::Rating::TaggedSymbol
639
656
  )
640
657
 
641
- # High
658
+ # Elevated risk of involvement in financial crime.
642
659
  HIGH =
643
660
  T.let(
644
661
  :high,
@@ -678,8 +695,9 @@ module Increase
678
695
  end
679
696
  attr_accessor :vendor
680
697
 
681
- # A reference to data stored in a third-party verification service. Your
682
- # integration may or may not use this field.
698
+ # If you are using a third-party service for identity verification, you can use
699
+ # this field to associate this Entity with the identifier that represents them in
700
+ # that service.
683
701
  sig do
684
702
  params(
685
703
  reference: String,
@@ -48,8 +48,9 @@ module Increase
48
48
  risk_rating: nil,
49
49
  # Additional documentation associated with the entity.
50
50
  supplemental_documents: nil,
51
- # A reference to data stored in a third-party verification service. Your
52
- # integration may or may not use this field.
51
+ # If you are using a third-party service for identity verification, you can use
52
+ # this field to associate this Entity with the identifier that represents them in
53
+ # that service.
53
54
  third_party_verification: nil,
54
55
  # Details of the trust entity to create. Required if `structure` is equal to
55
56
  # `trust`.
@@ -77,6 +78,7 @@ module Increase
77
78
  params(
78
79
  entity_id: String,
79
80
  corporation: Increase::EntityUpdateParams::Corporation::OrHash,
81
+ details_confirmed_at: Time,
80
82
  government_authority:
81
83
  Increase::EntityUpdateParams::GovernmentAuthority::OrHash,
82
84
  natural_person: Increase::EntityUpdateParams::NaturalPerson::OrHash,
@@ -93,6 +95,10 @@ module Increase
93
95
  # Details of the corporation entity to update. If you specify this parameter and
94
96
  # the entity is not a corporation, the request will fail.
95
97
  corporation: nil,
98
+ # When your user last confirmed the Entity's details. Depending on your program,
99
+ # you may be required to affirmatively confirm details with your users on an
100
+ # annual basis.
101
+ details_confirmed_at: nil,
96
102
  # Details of the government authority entity to update. If you specify this
97
103
  # parameter and the entity is not a government authority, the request will fail.
98
104
  government_authority: nil,
@@ -102,8 +108,9 @@ module Increase
102
108
  # An assessment of the entity’s potential risk of involvement in financial crimes,
103
109
  # such as money laundering.
104
110
  risk_rating: nil,
105
- # A reference to data stored in a third-party verification service. Your
106
- # integration may or may not use this field.
111
+ # If you are using a third-party service for identity verification, you can use
112
+ # this field to associate this Entity with the identifier that represents them in
113
+ # that service.
107
114
  third_party_verification: nil,
108
115
  # Details of the trust entity to update. If you specify this parameter and the
109
116
  # entity is not a trust, the request will fail.
@@ -740,13 +740,13 @@ module Increase
740
740
  module Rating
741
741
  extend Increase::Internal::Type::Enum
742
742
 
743
- # Low
743
+ # Minimal risk of involvement in financial crime.
744
744
  LOW: :low
745
745
 
746
- # Medium
746
+ # Moderate risk of involvement in financial crime.
747
747
  MEDIUM: :medium
748
748
 
749
- # High
749
+ # Elevated risk of involvement in financial crime.
750
750
  HIGH: :high
751
751
 
752
752
  def self?.values: -> ::Array[Increase::Models::Entity::RiskRating::rating]
@@ -1214,13 +1214,13 @@ module Increase
1214
1214
  module Rating
1215
1215
  extend Increase::Internal::Type::Enum
1216
1216
 
1217
- # Low
1217
+ # Minimal risk of involvement in financial crime.
1218
1218
  LOW: :low
1219
1219
 
1220
- # Medium
1220
+ # Moderate risk of involvement in financial crime.
1221
1221
  MEDIUM: :medium
1222
1222
 
1223
- # High
1223
+ # Elevated risk of involvement in financial crime.
1224
1224
  HIGH: :high
1225
1225
 
1226
1226
  def self?.values: -> ::Array[Increase::Models::EntityCreateParams::RiskRating::rating]
@@ -3,6 +3,7 @@ module Increase
3
3
  type entity_update_params =
4
4
  {
5
5
  corporation: Increase::EntityUpdateParams::Corporation,
6
+ details_confirmed_at: Time,
6
7
  government_authority: Increase::EntityUpdateParams::GovernmentAuthority,
7
8
  natural_person: Increase::EntityUpdateParams::NaturalPerson,
8
9
  risk_rating: Increase::EntityUpdateParams::RiskRating,
@@ -21,6 +22,10 @@ module Increase
21
22
  Increase::EntityUpdateParams::Corporation
22
23
  ) -> Increase::EntityUpdateParams::Corporation
23
24
 
25
+ attr_reader details_confirmed_at: Time?
26
+
27
+ def details_confirmed_at=: (Time) -> Time
28
+
24
29
  attr_reader government_authority: Increase::EntityUpdateParams::GovernmentAuthority?
25
30
 
26
31
  def government_authority=: (
@@ -53,6 +58,7 @@ module Increase
53
58
 
54
59
  def initialize: (
55
60
  ?corporation: Increase::EntityUpdateParams::Corporation,
61
+ ?details_confirmed_at: Time,
56
62
  ?government_authority: Increase::EntityUpdateParams::GovernmentAuthority,
57
63
  ?natural_person: Increase::EntityUpdateParams::NaturalPerson,
58
64
  ?risk_rating: Increase::EntityUpdateParams::RiskRating,
@@ -63,6 +69,7 @@ module Increase
63
69
 
64
70
  def to_hash: -> {
65
71
  corporation: Increase::EntityUpdateParams::Corporation,
72
+ details_confirmed_at: Time,
66
73
  government_authority: Increase::EntityUpdateParams::GovernmentAuthority,
67
74
  natural_person: Increase::EntityUpdateParams::NaturalPerson,
68
75
  risk_rating: Increase::EntityUpdateParams::RiskRating,
@@ -305,13 +312,13 @@ module Increase
305
312
  module Rating
306
313
  extend Increase::Internal::Type::Enum
307
314
 
308
- # Low
315
+ # Minimal risk of involvement in financial crime.
309
316
  LOW: :low
310
317
 
311
- # Medium
318
+ # Moderate risk of involvement in financial crime.
312
319
  MEDIUM: :medium
313
320
 
314
- # High
321
+ # Elevated risk of involvement in financial crime.
315
322
  HIGH: :high
316
323
 
317
324
  def self?.values: -> ::Array[Increase::Models::EntityUpdateParams::RiskRating::rating]
@@ -23,6 +23,7 @@ module Increase
23
23
  def update: (
24
24
  String entity_id,
25
25
  ?corporation: Increase::EntityUpdateParams::Corporation,
26
+ ?details_confirmed_at: Time,
26
27
  ?government_authority: Increase::EntityUpdateParams::GovernmentAuthority,
27
28
  ?natural_person: Increase::EntityUpdateParams::NaturalPerson,
28
29
  ?risk_rating: Increase::EntityUpdateParams::RiskRating,
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.70.0
4
+ version: 1.72.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Increase