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 @@
{
".": "0.1.0-alpha.39"
".": "0.1.0-alpha.40"
}
4 changes: 2 additions & 2 deletions .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 46
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-d5c3e3934333478f55af69889eafaea9b0eeae82a1597c5dec34426e9d55efd5.yml
openapi_spec_hash: 9ec42fee7f3124b3050846f74404b398
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-ded87cb73affcaff9cf779d9cfd119a4026cfc1757b39be95d933edea48a0328.yml
openapi_spec_hash: 0e6394b222fc68d7607114e70b72d23e
config_hash: 0892e2e0eeb0343a022afa62e9080dd1
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Changelog

## 0.1.0-alpha.40 (2026-01-05)

Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.39...v0.1.0-alpha.40)

### Features

* **api:** api update ([82c2483](https://github.com/Finch-API/finch-api-ruby/commit/82c2483e09e0facae50bc1fc3601b922ae86a5a5))


### Chores

* **internal:** codegen related update ([74a742a](https://github.com/Finch-API/finch-api-ruby/commit/74a742a5f1c7673a9f8fb06b5daaac5daf204fd5))


### Documentation

* prominently feature MCP server setup in root SDK readmes ([6d995c9](https://github.com/Finch-API/finch-api-ruby/commit/6d995c9789915687a71b11c33b1b5b8ccc9ffa48))

## 0.1.0-alpha.39 (2025-12-19)

Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.38...v0.1.0-alpha.39)
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:
finch-api (0.1.0.pre.alpha.39)
finch-api (0.1.0.pre.alpha.40)
connection_pool

GEM
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2025 Finch
Copyright 2026 Finch

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ The Finch Ruby library provides convenient access to the Finch REST API from any

It is generated with [Stainless](https://www.stainless.com/).

## MCP Server

Use the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.

[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl19)
[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%7D)

> Note: You may need to set environment variables in your MCP client.

## Documentation

Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).
Expand All @@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
<!-- x-release-please-start-version -->

```ruby
gem "finch-api", "~> 0.1.0.pre.alpha.39"
gem "finch-api", "~> 0.1.0.pre.alpha.40"
```

<!-- x-release-please-end -->
Expand Down
10 changes: 9 additions & 1 deletion lib/finch_api/models/sandbox/connection_create_response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String]
required :connection_id, String

# @!attribute entity_id
# The ID of the entity for this connection
#
# @return [String]
required :entity_id, String

# @!attribute products
#
# @return [Array<String>]
Expand All @@ -54,7 +60,7 @@ class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String, nil]
optional :token_type, String

# @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:, token_type: nil)
# @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:, token_type: nil)
# @param access_token [String]
#
# @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
Expand All @@ -65,6 +71,8 @@ class ConnectionCreateResponse < FinchAPI::Internal::Type::BaseModel
#
# @param connection_id [String] The ID of the new connection
#
# @param entity_id [String] The ID of the entity for this connection
#
# @param products [Array<String>]
#
# @param provider_id [String] The ID of the provider associated with the `access_token`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String]
required :connection_id, String

# @!attribute entity_id
# The ID of the entity for this connection
#
# @return [String]
required :entity_id, String

# @!attribute products
#
# @return [Array<String>]
Expand All @@ -50,7 +56,7 @@ class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String]
required :provider_id, String

# @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:)
# @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
# @param access_token [String]
#
# @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
Expand All @@ -61,6 +67,8 @@ class AccountCreateResponse < FinchAPI::Internal::Type::BaseModel
#
# @param connection_id [String] The ID of the new connection
#
# @param entity_id [String] The ID of the entity for this connection
#
# @param products [Array<String>]
#
# @param provider_id [String] The ID of the provider associated with the `access_token`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String]
required :company_id, String

# @!attribute connection_id
# The ID of the new connection
#
# @return [String]
required :connection_id, String

# @!attribute entity_id
# The ID of the entity whose status was updated
#
# @return [String]
required :entity_id, String

# @!attribute products
#
# @return [Array<String>]
Expand All @@ -39,24 +51,20 @@ class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel
# @return [String]
required :provider_id, String

# @!attribute connection_id
# The ID of the new connection
#
# @return [String, nil]
optional :connection_id, String

# @!method initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil)
# @!method initialize(account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
# @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
#
# @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
#
# @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
#
# @param connection_id [String] The ID of the new connection
#
# @param entity_id [String] The ID of the entity whose status was updated
#
# @param products [Array<String>]
#
# @param provider_id [String] The ID of the provider associated with the `access_token`
#
# @param connection_id [String] The ID of the new connection

# @see FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse#authentication_type
module AuthenticationType
Expand Down
2 changes: 1 addition & 1 deletion lib/finch_api/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module FinchAPI
VERSION = "0.1.0.pre.alpha.39"
VERSION = "0.1.0.pre.alpha.40"
end
8 changes: 8 additions & 0 deletions rbi/finch_api/models/sandbox/connection_create_response.rbi
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ module FinchAPI
sig { returns(String) }
attr_accessor :connection_id

# The ID of the entity for this connection
sig { returns(String) }
attr_accessor :entity_id

sig { returns(T::Array[String]) }
attr_accessor :products

Expand All @@ -55,6 +59,7 @@ module FinchAPI
FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String,
token_type: String
Expand All @@ -69,6 +74,8 @@ module FinchAPI
company_id:,
# The ID of the new connection
connection_id:,
# The ID of the entity for this connection
entity_id:,
products:,
# The ID of the provider associated with the `access_token`.
provider_id:,
Expand All @@ -85,6 +92,7 @@ module FinchAPI
FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String,
token_type: String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ module FinchAPI
sig { returns(String) }
attr_accessor :connection_id

# The ID of the entity for this connection
sig { returns(String) }
attr_accessor :entity_id

sig { returns(T::Array[String]) }
attr_accessor :products

Expand All @@ -50,6 +54,7 @@ module FinchAPI
FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String
).returns(T.attached_class)
Expand All @@ -63,6 +68,8 @@ module FinchAPI
company_id:,
# The ID of the new connection
connection_id:,
# The ID of the entity for this connection
entity_id:,
products:,
# The ID of the provider associated with the `access_token`
provider_id:
Expand All @@ -78,6 +85,7 @@ module FinchAPI
FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,29 +28,31 @@ module FinchAPI
sig { returns(String) }
attr_accessor :company_id

# The ID of the new connection
sig { returns(String) }
attr_accessor :connection_id

# The ID of the entity whose status was updated
sig { returns(String) }
attr_accessor :entity_id

sig { returns(T::Array[String]) }
attr_accessor :products

# The ID of the provider associated with the `access_token`
sig { returns(String) }
attr_accessor :provider_id

# The ID of the new connection
sig { returns(T.nilable(String)) }
attr_reader :connection_id

sig { params(connection_id: String).void }
attr_writer :connection_id

sig do
params(
account_id: String,
authentication_type:
FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String,
connection_id: String
provider_id: String
).returns(T.attached_class)
end
def self.new(
Expand All @@ -59,11 +61,13 @@ module FinchAPI
authentication_type:,
# [DEPRECATED] Use `connection_id` to associate a connection with an access token
company_id:,
# The ID of the new connection
connection_id:,
# The ID of the entity whose status was updated
entity_id:,
products:,
# The ID of the provider associated with the `access_token`
provider_id:,
# The ID of the new connection
connection_id: nil
provider_id:
)
end

Expand All @@ -74,9 +78,10 @@ module FinchAPI
authentication_type:
FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol,
company_id: String,
connection_id: String,
entity_id: String,
products: T::Array[String],
provider_id: String,
connection_id: String
provider_id: String
}
)
end
Expand Down
5 changes: 5 additions & 0 deletions sig/finch_api/models/sandbox/connection_create_response.rbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ module FinchAPI
authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
company_id: String,
connection_id: String,
entity_id: String,
products: ::Array[String],
provider_id: String,
token_type: String
Expand All @@ -24,6 +25,8 @@ module FinchAPI

attr_accessor connection_id: String

attr_accessor entity_id: String

attr_accessor products: ::Array[String]

attr_accessor provider_id: String
Expand All @@ -38,6 +41,7 @@ module FinchAPI
authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
company_id: String,
connection_id: String,
entity_id: String,
products: ::Array[String],
provider_id: String,
?token_type: String
Expand All @@ -49,6 +53,7 @@ module FinchAPI
authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
company_id: String,
connection_id: String,
entity_id: String,
products: ::Array[String],
provider_id: String,
token_type: String
Expand Down
Loading