Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "1.171.0"
".": "1.172.0"
}
4 changes: 2 additions & 2 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 227
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-4e978c9426fb846c81f3169f5c1bc7aad137577c13e52ac48fcc756e613a1557.yml
openapi_spec_hash: b44f228e3feac325305cd744c072ebc9
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-e32ea60c7028faaf552e2846c9a58f838b16922041d551664dcb1bfa343f38cf.yml
openapi_spec_hash: 8d3acf560b411999fee65eedda9e6a73
config_hash: ca52ca9a2968f330339fd50c1a386e05
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 1.172.0 (2026-01-06)

Full Changelog: [v1.171.0...v1.172.0](https://github.com/Increase/increase-ruby/compare/v1.171.0...v1.172.0)

### Features

* **api:** api update ([f7bc3df](https://github.com/Increase/increase-ruby/commit/f7bc3df6db78f863f763caf487a6ee1e0ae0d190))

## 1.171.0 (2026-01-05)

Full Changelog: [v1.170.0...v1.171.0](https://github.com/Increase/increase-ruby/compare/v1.170.0...v1.171.0)
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
increase (1.171.0)
increase (1.172.0)
connection_pool

GEM
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "increase", "~> 1.171.0"
gem "increase", "~> 1.172.0"
```

<!-- x-release-please-end -->
Expand Down
41 changes: 40 additions & 1 deletion lib/increase/models/entity.rb
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ class Entity < Increase::Internal::Type::BaseModel
required :supplemental_documents,
-> { Increase::Internal::Type::ArrayOf[Increase::EntitySupplementalDocument] }

# @!attribute terms_agreements
# The terms that the Entity agreed to. Not all programs are required to submit
# this data.
#
# @return [Array<Increase::Models::Entity::TermsAgreement>]
required :terms_agreements, -> { Increase::Internal::Type::ArrayOf[Increase::Entity::TermsAgreement] }

# @!attribute third_party_verification
# If you are using a third-party service for identity verification, you can use
# this field to associate this Entity with the identifier that represents them in
Expand All @@ -114,7 +121,7 @@ class Entity < Increase::Internal::Type::BaseModel
# @return [Symbol, Increase::Models::Entity::Type]
required :type, enum: -> { Increase::Entity::Type }

# @!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:)
# @!method initialize(id:, corporation:, created_at:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:)
# Some parameter documentations has been truncated, see {Increase::Models::Entity}
# for more details.
#
Expand Down Expand Up @@ -147,6 +154,8 @@ class Entity < Increase::Internal::Type::BaseModel
#
# @param supplemental_documents [Array<Increase::Models::EntitySupplementalDocument>] Additional documentation associated with the entity. This is limited to the firs
#
# @param terms_agreements [Array<Increase::Models::Entity::TermsAgreement>] The terms that the Entity agreed to. Not all programs are required to submit thi
#
# @param third_party_verification [Increase::Models::Entity::ThirdPartyVerification, nil] If you are using a third-party service for identity verification, you can use th
#
# @param trust [Increase::Models::Entity::Trust, nil] Details of the trust entity. Will be present if `structure` is equal to `trust`.
Expand Down Expand Up @@ -1027,6 +1036,36 @@ module Structure
# @return [Array<Symbol>]
end

class TermsAgreement < Increase::Internal::Type::BaseModel
# @!attribute agreed_at
# The timestamp of when the Entity agreed to the terms.
#
# @return [Time]
required :agreed_at, Time

# @!attribute ip_address
# The IP address the Entity accessed reviewed the terms from.
#
# @return [String]
required :ip_address, String

# @!attribute terms_url
# The URL of the terms agreement. This link will be provided by your bank partner.
#
# @return [String]
required :terms_url, String

# @!method initialize(agreed_at:, ip_address:, terms_url:)
# Some parameter documentations has been truncated, see
# {Increase::Models::Entity::TermsAgreement} for more details.
#
# @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
#
# @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
#
# @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
end

# @see Increase::Models::Entity#third_party_verification
class ThirdPartyVerification < Increase::Internal::Type::BaseModel
# @!attribute reference
Expand Down
42 changes: 41 additions & 1 deletion lib/increase/models/entity_create_params.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel
optional :supplemental_documents,
-> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::SupplementalDocument] }

# @!attribute terms_agreements
# The terms that the Entity agreed to. Not all programs are required to submit
# this data.
#
# @return [Array<Increase::Models::EntityCreateParams::TermsAgreement>, nil]
optional :terms_agreements,
-> { Increase::Internal::Type::ArrayOf[Increase::EntityCreateParams::TermsAgreement] }

# @!attribute third_party_verification
# If you are using a third-party service for identity verification, you can use
# this field to associate this Entity with the identifier that represents them in
Expand All @@ -78,7 +86,7 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel
# @return [Increase::Models::EntityCreateParams::Trust, nil]
optional :trust, -> { Increase::EntityCreateParams::Trust }

# @!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: {})
# @!method initialize(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
# Some parameter documentations has been truncated, see
# {Increase::Models::EntityCreateParams} for more details.
#
Expand All @@ -98,6 +106,8 @@ class EntityCreateParams < Increase::Internal::Type::BaseModel
#
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
#
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>] The terms that the Entity agreed to. Not all programs are required to submit thi
#
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
#
# @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
Expand Down Expand Up @@ -1514,6 +1524,36 @@ class SupplementalDocument < Increase::Internal::Type::BaseModel
# @param file_id [String] The identifier of the File containing the document.
end

class TermsAgreement < Increase::Internal::Type::BaseModel
# @!attribute agreed_at
# The timestamp of when the Entity agreed to the terms.
#
# @return [Time]
required :agreed_at, Time

# @!attribute ip_address
# The IP address the Entity accessed reviewed the terms from.
#
# @return [String]
required :ip_address, String

# @!attribute terms_url
# The URL of the terms agreement. This link will be provided by your bank partner.
#
# @return [String]
required :terms_url, String

# @!method initialize(agreed_at:, ip_address:, terms_url:)
# Some parameter documentations has been truncated, see
# {Increase::Models::EntityCreateParams::TermsAgreement} for more details.
#
# @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
#
# @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
#
# @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
end

class ThirdPartyVerification < Increase::Internal::Type::BaseModel
# @!attribute reference
# The reference identifier for the third party verification.
Expand Down
4 changes: 3 additions & 1 deletion lib/increase/resources/entities.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class Entities
#
# Create an Entity
#
# @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: {})
# @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
#
# @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
#
Expand All @@ -26,6 +26,8 @@ class Entities
#
# @param supplemental_documents [Array<Increase::Models::EntityCreateParams::SupplementalDocument>] Additional documentation associated with the entity.
#
# @param terms_agreements [Array<Increase::Models::EntityCreateParams::TermsAgreement>] The terms that the Entity agreed to. Not all programs are required to submit thi
#
# @param third_party_verification [Increase::Models::EntityCreateParams::ThirdPartyVerification] If you are using a third-party service for identity verification, you can use th
#
# @param trust [Increase::Models::EntityCreateParams::Trust] Details of the trust entity to create. Required if `structure` is equal to `trus
Expand Down
2 changes: 1 addition & 1 deletion lib/increase/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Increase
VERSION = "1.171.0"
VERSION = "1.172.0"
end
54 changes: 54 additions & 0 deletions rbi/increase/models/entity.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ module Increase
sig { returns(T::Array[Increase::EntitySupplementalDocument]) }
attr_accessor :supplemental_documents

# The terms that the Entity agreed to. Not all programs are required to submit
# this data.
sig { returns(T::Array[Increase::Entity::TermsAgreement]) }
attr_accessor :terms_agreements

# If you are using a third-party service for identity verification, you can use
# this field to associate this Entity with the identifier that represents them in
# that service.
Expand Down Expand Up @@ -145,6 +150,7 @@ module Increase
structure: Increase::Entity::Structure::OrSymbol,
supplemental_documents:
T::Array[Increase::EntitySupplementalDocument::OrHash],
terms_agreements: T::Array[Increase::Entity::TermsAgreement::OrHash],
third_party_verification:
T.nilable(Increase::Entity::ThirdPartyVerification::OrHash),
trust: T.nilable(Increase::Entity::Trust::OrHash),
Expand Down Expand Up @@ -188,6 +194,9 @@ module Increase
# first 10 documents for an entity. If an entity has more than 10 documents, use
# the GET /entity_supplemental_documents list endpoint to retrieve them.
supplemental_documents:,
# The terms that the Entity agreed to. Not all programs are required to submit
# this data.
terms_agreements:,
# If you are using a third-party service for identity verification, you can use
# this field to associate this Entity with the identifier that represents them in
# that service.
Expand Down Expand Up @@ -218,6 +227,7 @@ module Increase
structure: Increase::Entity::Structure::TaggedSymbol,
supplemental_documents:
T::Array[Increase::EntitySupplementalDocument],
terms_agreements: T::Array[Increase::Entity::TermsAgreement],
third_party_verification:
T.nilable(Increase::Entity::ThirdPartyVerification),
trust: T.nilable(Increase::Entity::Trust),
Expand Down Expand Up @@ -1730,6 +1740,50 @@ module Increase
end
end

class TermsAgreement < Increase::Internal::Type::BaseModel
OrHash =
T.type_alias do
T.any(Increase::Entity::TermsAgreement, Increase::Internal::AnyHash)
end

# The timestamp of when the Entity agreed to the terms.
sig { returns(Time) }
attr_accessor :agreed_at

# The IP address the Entity accessed reviewed the terms from.
sig { returns(String) }
attr_accessor :ip_address

# The URL of the terms agreement. This link will be provided by your bank partner.
sig { returns(String) }
attr_accessor :terms_url

sig do
params(
agreed_at: Time,
ip_address: String,
terms_url: String
).returns(T.attached_class)
end
def self.new(
# The timestamp of when the Entity agreed to the terms.
agreed_at:,
# The IP address the Entity accessed reviewed the terms from.
ip_address:,
# The URL of the terms agreement. This link will be provided by your bank partner.
terms_url:
)
end

sig do
override.returns(
{ agreed_at: Time, ip_address: String, terms_url: String }
)
end
def to_hash
end
end

class ThirdPartyVerification < Increase::Internal::Type::BaseModel
OrHash =
T.type_alias do
Expand Down
Loading